LikeC4 for MkDocs
Project description
mkdocs-likec4
MkDocs plugin for embedding LikeC4 architecture diagrams.
Quick Start
- Ensure
likec4andgraphvizare available on the build system - Install the
mkdocs-likec4plugin viapip:
pip install mkdocs-likec4
- Add the plugin to your
mkdocs.yml:
plugins:
- search
- mkdocs-likec4
- Start embedding views in your markdown:
```likec4-view
<your-view-id>
```
Documentation
For detailed instructions, configuration options and a demo, please read the documentation.
Development
Local 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
Manually trigger the release workflow via GitHub Actions, which will auto-bump the plugin version and perform the release process.
PyPi publishing is set up via trusted publishing.
License
mkdocs-likec4 is licensed under the Apache License, Version 2.0.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocs_likec4-1.2.2.tar.gz.
File metadata
- Download URL: mkdocs_likec4-1.2.2.tar.gz
- Upload date:
- Size: 16.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4e1da3ea2ff31b2310a6fcf66137822d7a778369ba9bad3c16c78f554ede194a
|
|
| MD5 |
8f55622c389e0bcadba49f9bbffdd4bf
|
|
| BLAKE2b-256 |
c34ae2e40ddcdf5c3fd4457e908a809cc41108a184b8adecb9756360503d8f49
|
Provenance
The following attestation bundles were made for mkdocs_likec4-1.2.2.tar.gz:
Publisher:
release.yml on doubleSlashde/mkdocs-likec4
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdocs_likec4-1.2.2.tar.gz -
Subject digest:
4e1da3ea2ff31b2310a6fcf66137822d7a778369ba9bad3c16c78f554ede194a - Sigstore transparency entry: 1882911280
- Sigstore integration time:
-
Permalink:
doubleSlashde/mkdocs-likec4@6a8f3fb1b263a58aa74c2a48cae84c41bf054c56 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/doubleSlashde
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@6a8f3fb1b263a58aa74c2a48cae84c41bf054c56 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file mkdocs_likec4-1.2.2-py3-none-any.whl.
File metadata
- Download URL: mkdocs_likec4-1.2.2-py3-none-any.whl
- Upload date:
- Size: 11.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6400f340eb79697a9ca338a760e1dd9eac2d273f8ee20224fb2c20e6e33cad73
|
|
| MD5 |
664e88844538df1767dfb4624b9fc203
|
|
| BLAKE2b-256 |
79264fb11ee7344e2bc3f5603b41bdea58697b86ad9ce52b4251ca95e599d26a
|
Provenance
The following attestation bundles were made for mkdocs_likec4-1.2.2-py3-none-any.whl:
Publisher:
release.yml on doubleSlashde/mkdocs-likec4
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdocs_likec4-1.2.2-py3-none-any.whl -
Subject digest:
6400f340eb79697a9ca338a760e1dd9eac2d273f8ee20224fb2c20e6e33cad73 - Sigstore transparency entry: 1882911426
- Sigstore integration time:
-
Permalink:
doubleSlashde/mkdocs-likec4@6a8f3fb1b263a58aa74c2a48cae84c41bf054c56 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/doubleSlashde
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@6a8f3fb1b263a58aa74c2a48cae84c41bf054c56 -
Trigger Event:
workflow_dispatch
-
Statement type:
