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.

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

Use unist trees for all Markdown values #371

Closed
jfirebaugh opened this issue Mar 13, 2016 · 0 comments
Closed

Use unist trees for all Markdown values #371

jfirebaugh opened this issue Mar 13, 2016 · 0 comments

Comments

@jfirebaugh
Copy link
Member

The "comment" object (documentationjs/documentation-schema#1 / #18) should have no fields whose type is "Markdown-formatted string". Instead, the type of such fields should always be "unist tree", with all markdown syntax and inline jsdoc @links and such parsed into an AST.

Downstream modules such as themes should never need to require('jsdoc-inline-lex') or use remark's process. All they should do is traverse an AST, generating output.

rhendric pushed a commit to rhendric/documentation that referenced this issue Sep 15, 2022
)

* Document roles, role inference and role annotations

* fixup! Document roles, role inference and role annotations
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant