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

Upgrade "documentation" to the last version #3351

Closed
knsv opened this issue Aug 23, 2022 · 3 comments · Fixed by #3515
Closed

Upgrade "documentation" to the last version #3351

knsv opened this issue Aug 23, 2022 · 3 comments · Fixed by #3515
Assignees
Labels

Comments

@knsv
Copy link
Collaborator

knsv commented Aug 23, 2022

A simple version change from version 13.2 to 14 is not possible without modifications. We get the following error message in the console when running the command yarn post build:

$ documentation build src/mermaidAPI.js src/config.js src/defaultConfig.js --shallow -f md --markdown-toc false > docs/Setup.md
Error: Cannot handle unknown node `table`
    at Object.unknown (file:///Users/knuts/source/priv/atlantica/mermaid/node_modules/mdast-util-to-markdown/lib/index.js:91:9)
    at Object.one [as handle] (file:///Users/knuts/source/priv/atlantica/mermaid/node_modules/zwitch/index.js:52:17)
    at containerFlow (file:///Users/knuts/source/priv/atlantica/mermaid/node_modules/mdast-util-to-markdown/lib/util/container-flow.js:34:17)
    at Object.root (file:///Users/knuts/source/priv/atlantica/mermaid/node_modules/mdast-util-to-markdown/lib/handle/root.js:13:10)
    at Object.one [as handle] (file:///Users/knuts/source/priv/atlantica/mermaid/node_modules/zwitch/index.js:52:17)
    at toMarkdown (file:///Users/knuts/source/priv/atlantica/mermaid/node_modules/mdast-util-to-markdown/lib/index.js:50:24)
    at compiler (file:///Users/knuts/source/priv/atlantica/mermaid/node_modules/remark-stringify/lib/index.js:16:12)
    at Function.stringify (file:///Users/knuts/source/priv/atlantica/mermaid/node_modules/unified/lib/index.js:290:12)
    at file:///Users/knuts/source/priv/atlantica/mermaid/node_modules/documentation/src/output/markdown.js:28:59
error Command failed with exit code 1.

Help with upgrading the tool would be much appreciated!

@github-actions github-actions bot added the Status: Triage Needs to be verified, categorized, etc label Aug 23, 2022
@knsv knsv removed the Status: Triage Needs to be verified, categorized, etc label Aug 23, 2022
@aloisklink
Copy link
Member

This is due to a bug/regression in v13.2.2 and later of the the documentation package, which broke outputting GitHub Flavored Markdown (tables are a GFM only feature).

I've made a PR to fix it: documentationjs/documentation#1553

@knsv knsv changed the title Upgrade "documentation" to the laster version Upgrade "documentation" to the last version Sep 2, 2022
@emersonbottero
Copy link
Contributor

My new documentation does not rely on documentation..
actually I had to remove since it conflicts with my version

@aloisklink
Copy link
Member

My new documentation does not rely on documentation.. actually I had to remove since it conflicts with my version

Awesome :) I've updated your PR to say Resolves https://github.com/mermaid-js/mermaid/issues/3351, so this issue will get auto-closed if/when your PR gets merged.

To be honest, documentation.js is quite unmaintained right now, so it does make sense to move to a different system.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants