mermaid 8.0 is coming and call for documentation contributors

[tylerlong]

First of all, a good news for mermaid users

mermaid 8.0 stable version is coming soon. 🎉

You can install the beta version to have a try now!

Major changes:

1. mermaid 8.0 works with d3 version 4 (bye d3 version 3)
2. it allows you to specify xAxis date format easily
3. it allows you to specify your own CSS or the whole theme easily
4. diagram CSS is scoped in its own ID so it won't pollute the DOM
5. flowchart curves are supported.
6. SequenceDiagram: Add support for multiple alt else statements
7. All dependencies libraries have been updated to the latest version
8. It's pretty modern and it has no problem working together with webpack & parcel
9. lots of issues fixed and lots of small improvements

Call for documentation contributors. ❤️

Documentation is here: https://mermaidjs.github.io/ It's based on GitBook and its source code is here: https://github.com/mermaidjs/mermaid-gitbook

Its content is pretty dated. Lots of knowledges there are even wrong.

So please contribute to the documentation.

How

Recently I closed lots of issues in the following projects:

• https://github.com/knsv/mermaid
• https://github.com/mermaidjs/mermaid.cli
• https://github.com/mermaidjs/mermaid-live-editor

From those recently closed issues, you can find lots of mermaid usage information which is more correct than the current documentation. For example, mermaid diagram now uses inline CSS instead of external CSS file (this is mainly to make the SVG file portable, so you can download it.)

If you know something useful about mermaid, or you know something is wrong in the documentation. Please fork https://github.com/mermaidjs/mermaid-gitbook and send PRs.

Thank you very much!

[renegare]

Hi is there a deadline to complete this documentation? or will v8 be held up until documentation is sufficiently updated?

Either way I'd be happy to help out as I have just spent some time reading through your code :). Would be great to be directed to the sections that need more help than others?

[tylerlong]

@renegare there isn't a deadline because this is a community project run by volunteers. For now you can install and try the pre-release versions. At the moment it is mermaid@8.0.0-rc.1.

For the documentation, I think we should include the major changes we made for v8. I made a list above. So maybe you can pick one or more to document them. :)

For example: https://mermaidjs.github.io/flowchart.html doesn't mention anything about flowchart curves are supported. We can add the content there.

[ManasiGandhi]

Hi. I am interested in contributing. It would be helpful to know where to begin.

[Amruta-Ranade]

Hi..is this issue still up-for-grabs?

[flying-sheep]

hi @tylerlong, how’s the maintenance status of this repo? I haven’t seen anyone pushing anything since april!

[benelog]

Mermaid 8.0.0 was released at https://www.npmjs.com/package/mermaid .

It will be obvious if the tag is added to the source repository.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.