semiliterate
semiliterate is a standalone extraction engine and CLI for building markdown
documentation from semiliterate source files. It preserves the extraction
behavior from mkdocs-simple-plugin without depending on MkDocs.
Install
pip install -e .
CLI
semiliterate build --source . --out .build-docs
Options:
--config PATH: load YAML config--source PATH: source tree root--out PATH: output tree--include-mode copy|symlink|skip: how included files are materialized--dry-run: scan and report without writing files-v,--verbose: enable info logging
Config
The YAML config is intentionally close to the previous plugin config:
folders:
- src
- examples
ignore:
- .git/**
- node_modules/**
- _site/**
include:
- "*.md"
- "*.png"
semiliterate:
- pattern: ".*"
terminate: "^\\W*md-ignore"
extract:
- start: "^\\s*\"\"\"\\W?md\\b"
stop: "^\\s*\"\"\"\\s*$"
If you want to keep the built-in defaults and add a few more file types,
use include_extra and ignore_extra:
include_extra:
- "*.csv"
- "*.webp"
ignore_extra:
- "_build/**"
include and ignore still replace the defaults if you set them directly.
Python API
from semiliterate import ExtractionPattern
from semiliterate import Semiliterate
from semiliterate import build_docs
build_docs(source=".", out=".build-docs")
Useful exports:
SemiliterateExtractionPatternSimpleScannerbuild_docsload_config
Compatibility Notes
- The extraction regexes and inline parameter behavior are carried over
directly from
mkdocs-simple-plugin. .mkdocsignore, include matching, hidden-file handling, and destination file naming follow the original implementation.- This package does not depend on MkDocs and does not include any plugin or site-generator integration.
Example
Given a source file:
"""md
# Title
Some docs.
"""
Running:
semiliterate build --source . --out .build-docs
creates:
.build-docs/<source-file-basename>.md
1 maintainer
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 semiliterate-0.2.0.tar.gz.
File metadata
- Download URL: semiliterate-0.2.0.tar.gz
- Upload date:
- Size: 15.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
330ba2ee592dd66328446157fad9e320d91f64f7ce5e892f6e9dd7e5da673b3e
|
|
| MD5 |
ef8074b26d6a743323cbfcf6d06eff39
|
|
| BLAKE2b-256 |
700916472fc517833a6974c58beb71a849cdc4168186642b630f8fcf45623f63
|
Provenance
The following attestation bundles were made for semiliterate-0.2.0.tar.gz:
Publisher:
release.yml on PrimerPages/semiliterate
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
semiliterate-0.2.0.tar.gz -
Subject digest:
330ba2ee592dd66328446157fad9e320d91f64f7ce5e892f6e9dd7e5da673b3e - Sigstore transparency entry: 2239495451
- Sigstore integration time:
-
Permalink:
PrimerPages/semiliterate@11901c2cb2980dd0d92cdc5eae68a1eb48dccd4c -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/PrimerPages
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@11901c2cb2980dd0d92cdc5eae68a1eb48dccd4c -
Trigger Event:
release
-
Statement type:
File details
Details for the file semiliterate-0.2.0-py3-none-any.whl.
File metadata
- Download URL: semiliterate-0.2.0-py3-none-any.whl
- Upload date:
- Size: 16.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bb49209fcdd2b05aa92156461cba4e7b5b300d5e91c225507d0fab746994462c
|
|
| MD5 |
4e6c13eb13a37bf77c74662a10d0aa3d
|
|
| BLAKE2b-256 |
ce2278a60cfbd38d7aafed9c47aee8793c84d24f1c7d65f3bd67623b19a7eb0d
|
Provenance
The following attestation bundles were made for semiliterate-0.2.0-py3-none-any.whl:
Publisher:
release.yml on PrimerPages/semiliterate
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
semiliterate-0.2.0-py3-none-any.whl -
Subject digest:
bb49209fcdd2b05aa92156461cba4e7b5b300d5e91c225507d0fab746994462c - Sigstore transparency entry: 2239496104
- Sigstore integration time:
-
Permalink:
PrimerPages/semiliterate@11901c2cb2980dd0d92cdc5eae68a1eb48dccd4c -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/PrimerPages
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@11901c2cb2980dd0d92cdc5eae68a1eb48dccd4c -
Trigger Event:
release
-
Statement type:
