Skip to content

doubleSlashde/mkdocs-likec4

Repository files navigation

mkdocs-likec4

MkDocs plugin for embedding LikeC4 architecture diagrams.

Quick Start

  1. Ensure likec4 and graphviz are available on the build system.
  2. Install the mkdocs-likec4 plugin via pip:
pip install mkdocs-likec4

3.Add the plugin to your mkdocs.yml:

plugins:
  - mkdocs-likec4
  1. Start embedding views in your markdown:
```likec4-view
<your-view-id>
```

Documentation

For complete documentation with available options and examples, please read the Documentation.

Development

Registry setup

Run ./local-preview in your terminal to build and run a MkDocs server with the plugin installed, serving on http://127.0.0.1:8000/.

Releasing

Trigger the manual release workflow via GitHub Actions.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •