Support for JSDoc Tutorials
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 206
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Description
[JSDoc Tutorials](http://usejsdoc.org/about-tutorials.html) offer some advantages over Doclets articles:
- Ability to link to tutorial from API documentation via `@tutorial` tag
- Ability to link to API documentation from tutorial via `{@link}` tag
- Support for a JSON file to specify an order and even a hierarchy for the tutorial index
If I understand the code correctly, Doclets uses its own Markdown parser to create articles. Would it be possible to add support for JSDoc tutorials?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing Doclets' current Markdown-based article handling alongside the linked JSDoc Tutorials documentation. Define how tutorial links from API documentation, API links from tutorials, and the JSON-defined tutorial order and hierarchy should work; done means these three capabilities are supported.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100