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

fix: fix GFM markdown output #1553

Merged
merged 1 commit into from
Jan 30, 2024

Conversation

aloisklink
Copy link
Contributor

GFM output is currently broken (since v13.2.2), which prevents tables from being written to markdown.

For example, trying to use documentation ./__tests__/fixture/html/nest.input.js -f md will throw an Error: Cannot handle unknown node table` due to this GFM only syntax:

/**
* | Col 1 | Col 2 | Col 3 |
* |-------|-------|-------|
* | Dat 1 | Dat 2 | Dat 3 |
* | Dat 4 | Dat 5 | Dat 6 |
*/
var tableObj = {};

This is because as of remark v13.0.0, GFM support was moved to the remark-gfm pacakge.

6b5bc25 fixed parsing GFM, however, it didn't add GFM support for markdown
output.

Fixes: f4a46b1

GFM output is currently broken (since v13.2.2),
which prevents tables from being written to markdown.

This is because as of [remark v13.0.0][1], GFM support was added
to the remark-gfm pacakge.

documentationjs@6b5bc25
fixed parsing GFM, however, it didn't add GFM support for markdown
output.

[1]: https://github.com/remarkjs/remark/releases/tag/13.0.0

Fixes: f4a46b1
@tmcw tmcw merged commit 1cc2f98 into documentationjs:master Jan 30, 2024
@aloisklink aloisklink deleted the fix-gfm-markdown-output branch January 30, 2024 23:01
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

Successfully merging this pull request may close these issues.

2 participants