Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support for JSDoc Tutorials #230

Open
tf opened this issue Oct 12, 2016 · 1 comment
Open

Support for JSDoc Tutorials #230

tf opened this issue Oct 12, 2016 · 1 comment

Comments

@tf
Copy link

tf commented Oct 12, 2016

JSDoc Tutorials 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?
@matt-hammond-001
Copy link

+1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tf @matt-hammond-001