Skip to content

Mkdocs integrate with external charts js like Mermaid, sequences-diagram, flowchart.js ...

Notifications You must be signed in to change notification settings

hahadaphne/mkdocs_UML

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MkDocs integrate with mermaid, sequence, flowchart

For full documentation visit mkdocs.org.

According to MkDocs的使用-甘特图, Mkdocs using gantt with mermaid. I changed a little configuration and script for mermaid version 7.x.x.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs help - Print this help message.

Project layout

mkdocs.yml          # The configuration file.
docs/
    index.md        # The documentation homepage.
    uml.md          # Some UML chart testing page.
js/
    umlconvert.js   # Integrate external js. Can initial or do some settings here.

About

Mkdocs integrate with external charts js like Mermaid, sequences-diagram, flowchart.js ...

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published