Skip to main content

LikeC4 for MkDocs

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_likec4-1.0.0.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_likec4-1.0.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_likec4-1.0.0.tar.gz.

File metadata

  • Download URL: mkdocs_likec4-1.0.0.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mkdocs_likec4-1.0.0.tar.gz
Algorithm Hash digest
SHA256 8c1c117e25d16b1afedbf55ee7a5d9709889bd4d127fd8db464077b45802ad53
MD5 ea34cdf49b2b856130ff80a1406cefc1
BLAKE2b-256 da4117a951951ea8ba54dbf981878c6e5b9707f6bbc19e592c9b52bf03bf6b71

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_likec4-1.0.0.tar.gz:

Publisher: release.yml on doubleSlashde/mkdocs-likec4

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mkdocs_likec4-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: mkdocs_likec4-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mkdocs_likec4-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3e4367086d620028fd8023a891d5195f328557a389f7045173764345356429df
MD5 9945cc239441810ca8a711f6763b3e33
BLAKE2b-256 039e2d8e01beb3dcef6bb5adb1ed2c41173c1e33b7594d0a9243536c1ef5a8f4

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_likec4-1.0.0-py3-none-any.whl:

Publisher: release.yml on doubleSlashde/mkdocs-likec4

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page