Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2025-02-07 06:31:17 +01:00
Code Issues Releases Wiki Activity

Documentation (#6568)

Browse Source 
Closes #6567
This commit is contained in:
Simon Marquis 2023-12-27 10:44:57 +01:00 committed by GitHub
parent 43ed6fac8d
commit fc75fcd79e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/reference/diagrams.md
View File

@ -9,7 +9,7 @@ different technical components, and are a great addition to project
documentation. Material for MkDocs integrates with [Mermaid.js], a very documentation. Material for MkDocs integrates with [Mermaid.js], a very
popular and flexible solution for drawing diagrams. popular and flexible solution for drawing diagrams.
[Mermaid.js]: https://mermaid-js.github.io/mermaid/ [Mermaid.js]: https://mermaid.js.org/
## Configuration ## Configuration
@ -78,7 +78,7 @@ graph LR
</div> </div>
[Flowcharts]: https://mermaid-js.github.io/mermaid/#/flowchart [Flowcharts]: https://mermaid.js.org/syntax/flowchart.html
### Using sequence diagrams ### Using sequence diagrams
@ -118,7 +118,7 @@ sequenceDiagram
</div> </div>
[Sequence diagrams]: https://mermaid-js.github.io/mermaid/#/sequenceDiagram [Sequence diagrams]: https://mermaid.js.org/syntax/sequenceDiagram.html
### Using state diagrams ### Using state diagrams
@ -160,7 +160,7 @@ stateDiagram-v2
</div> </div>
[State diagrams]: https://mermaid-js.github.io/mermaid/#/stateDiagram [State diagrams]: https://mermaid.js.org/syntax/stateDiagram.html
### Using class diagrams ### Using class diagrams
@ -232,7 +232,7 @@ classDiagram
</div> </div>
[Class diagrams]: https://mermaid-js.github.io/mermaid/#/classDiagram [Class diagrams]: https://mermaid.js.org/syntax/classDiagram.html
### Using entity-relationship diagrams ### Using entity-relationship diagrams
@ -268,7 +268,7 @@ erDiagram
</div> </div>
[entity-relationship diagram]: https://mermaid-js.github.io/mermaid/#/entityRelationshipDiagram [entity-relationship diagram]: https://mermaid.js.org/syntax/entityRelationshipDiagram.html
### Other diagram types ### Other diagram types
@ -278,8 +278,8 @@ Besides the diagram types listed above, [Mermaid.js] provides support for
for MkDocs. Those diagrams should still work as advertised by [Mermaid.js], but for MkDocs. Those diagrams should still work as advertised by [Mermaid.js], but
we don't consider them a good choice, mostly as they don't work well on mobile. we don't consider them a good choice, mostly as they don't work well on mobile.
[pie charts]: https://mermaid-js.github.io/mermaid/#/pie [pie charts]: https://mermaid.js.org/syntax/pie.html
[gantt charts]: https://mermaid-js.github.io/mermaid/#/gantt [gantt charts]: https://mermaid.js.org/syntax/gantt.html
[user journeys]: https://mermaid-js.github.io/mermaid/#/user-journey [user journeys]: https://mermaid.js.org/syntax/userJourney.html
[git graphs]: https://mermaid-js.github.io/mermaid/#/gitgraph [git graphs]: https://mermaid.js.org/syntax/gitgraph.html
[requirement diagrams]: https://mermaid-js.github.io/mermaid/#/requirementDiagram [requirement diagrams]: https://mermaid.js.org/syntax/requirementDiagram.html