mermaid-js / mermaid

Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
https://mermaid.js.org
MIT License
68.69k stars 6.07k forks source link

DOCS: Add blog post - Documentation Software #5519

Closed huynhicode closed 1 month ago

huynhicode commented 1 month ago

:bookmark_tabs: Summary

This PR contains updates to the Blog page.

Adds Mermaid Chart blog post: How to Choose the Right Documentation Software

Resolves # n/a

:straight_ruler: Design Decisions

Design decisions made by the Mermaid Chart team.

:clipboard: Tasks

Make sure you

netlify[bot] commented 1 month ago

Deploy Preview for mermaid-js ready!

Name Link
Latest commit 635aaf46dfc349d3ae378aa0f0fed313317737f1
Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/664312e512f45b0008bc10b9
Deploy Preview https://deploy-preview-5519--mermaid-js.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 77.29%. Comparing base (76801ff) to head (635aaf4). Report is 3 commits behind head on master.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/mermaid-js/mermaid/pull/5519/graphs/tree.svg?width=650&height=150&src=pr&token=BaET4V1BdM&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mermaid-js)](https://app.codecov.io/gh/mermaid-js/mermaid/pull/5519?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mermaid-js) ```diff @@ Coverage Diff @@ ## master #5519 +/- ## ========================================== - Coverage 78.81% 77.29% -1.52% ========================================== Files 175 175 Lines 14531 14531 Branches 868 868 ========================================== - Hits 11452 11232 -220 - Misses 2871 3091 +220 Partials 208 208 ``` | [Flag](https://app.codecov.io/gh/mermaid-js/mermaid/pull/5519/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mermaid-js) | Coverage Δ | | |---|---|---| | [e2e](https://app.codecov.io/gh/mermaid-js/mermaid/pull/5519/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mermaid-js) | `82.41% <ø> (-1.88%)` | :arrow_down: | | [unit](https://app.codecov.io/gh/mermaid-js/mermaid/pull/5519/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mermaid-js) | `43.37% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mermaid-js#carryforward-flags-in-the-pull-request-comment) to find out more. [see 8 files with indirect coverage changes](https://app.codecov.io/gh/mermaid-js/mermaid/pull/5519/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mermaid-js)