Skip to main content

hedron-docs

Experimental Markdown compiler and Hedron application toolkit.

hedron-docs turns a bounded Markdown corpus into a deterministic JSON manifest and renders that manifest through native Hedron components. The 0.5 surface is intentionally experimental and may change:

Package maturity: Beta tooling-grade · Repository package version: 0.5.0 · Import: hedron_docs

from hedron_docs import compile_site, create_docs_app, load_config

config = load_config("hedron-docs.toml")
manifest = compile_site(config)
app = create_docs_app(manifest)

Local images and linked files are validated, fingerprinted, and embedded in the immutable manifest; the app serves them from /_hedron-docs/assets/... with content hashes and bounded sizes.

schema_version = 4

[site]
title = "Project docs"
docs_dir = "docs"
base_url = "https://docs.example.com"

[build]
output = "build/hedron-docs/site.json"
max_source_bytes = 2000000
max_asset_bytes = 10000000
max_nodes = 10000
max_depth = 64
max_table_cells = 10000
max_code_blocks = 200
max_code_block_bytes = 256000
max_directives = 100
max_query_length = 200

The 0.4 compiler lowers CommonMark, tables, definition lists, footnotes, admonitions, details, content tabs, API directives, and allowlisted demo references directly from parser tokens into a closed typed AST, then renders them through native Hedron primitives. Headings expose stable alias anchors; code and tables are responsive; code blocks include language labels and native copy controls. Every parsed node carries a stable source span. Raw HTML and unknown extension syntax fail with a diagnostic containing a code, title, location, explanation, and remediation.

The 0.5 application shell is Hedron-native: it provides accessible skip links and landmarks, responsive primary/mobile navigation, breadcrumbs, release banners, source actions, and a no-JavaScript color-mode preference form.

The package is not a drop-in MkDocs plugin. import-mkdocs reads site metadata, navigation, and exclusions as a migration aid; it never executes arbitrary MkDocs plugins or theme code.

hedron-docs check hedron-docs.toml
hedron-docs build hedron-docs.toml
hedron-docs serve hedron-docs.toml
hedron-docs import-mkdocs mkdocs.yml

The repository proving app is available at apps/hedron-docs/app.py:app and can be started with uv run uvicorn --app-dir apps/hedron-docs app:app.

This package is experimental and is not part of Hedron's stable support matrix.

Metadata

Release files for hedron-docs 0.5.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hedron-docs 0.5.2
File Size Uploaded Provenance Actions
hedron_docs-0.5.2.tar.gz 40.3 kB Without provenance Details for hedron_docs-0.5.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for hedron-docs 0.5.2
File Interpreter ABI Platform Actions
hedron_docs-0.5.2-py3-none-any.whl Python 3 none any Details for hedron_docs-0.5.2-py3-none-any.whl

Total release size: 85.1 kB

Release files / hedron_docs-0.5.2.tar.gz

Download URL hedron_docs-0.5.2.tar.gz
Size 40.3 kB
Tags Source
SHA-256 checksum
How to use checksums
a861a88de891928cc2366c16022e3b6dc9e889a6feb9b47b8b69e4aa3d22119e
BLAKE2b-256 checksum
How to use checksums
45fcf1e37781afb078715e0e9069ff75f19816e7b68393d1b96c709555c8b444
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.1 {"installer":{"name":"uv","version":"0.12.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / hedron_docs-0.5.2-py3-none-any.whl

Download URL hedron_docs-0.5.2-py3-none-any.whl
Size 44.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a1ad895e5bd3096695d76f2c44303ae441aaa3ea73ef1e2448de6460af400317
BLAKE2b-256 checksum
How to use checksums
a9509cfa06849983a27279c904c6fc1233fc22fdbdbb70de2bb05b6732358ab7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.1 {"installer":{"name":"uv","version":"0.12.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for hedron-docs 0.5.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page