markpub
MarkPub builds a static HTML website from a directory of Markdown files.
The website supports wiki-links, transclusion, and provides full-text
search.
MarkPub installs configuration files that GitHub Pages and Netlify can use to automatically publish the HTML files on the web.
Requirements
- Python 3.12 or higher.
Install
Using pip
pip install markpub
Usage
Overview
markpub [--version] <command> [options]
Available commands:
init- Initialize a new MarkPub sitebuild- Build HTML website from Markdown files
Commands
markpub init <directory>
Initialize a new MarkPub site in the specified directory. This creates:
.markpub/markpub.yaml- Site configuration file- Configuration files for GitHub Pages/Netlify deployment
Sidebar.md- Website navigation links displayed sidebar on webpages
Example:
markpub init my-wiki
markpub build [options]
Build a static website from Markdown files.
Required options:
-i, --input <directory>- Input directory containing Markdown files-o, --output <directory>- Output directory for generated HTML files
Optional options:
--config, -c <file>- Path to YAML config file (default:./markpub.yaml)--root, -r <name>- Website root directory name (needed for GitHub Pages hosting)--lunr- Create lunr search index (requires npm and lunr to be installed)--commits- Include Git commit messages and times in All Pages
Examples:
# Basic build
markpub build -i my-wiki -o my-wiki-site
# Build with search
markpub build -i my-wiki -o my-wiki-site --lunr
# Build for GitHub Pages with Git history
markpub build -i my-wiki -o my-wiki-site --root my-repo --commits
Getting Help
Use --help with any command for detailed usage information:
markpub --help
markpub init --help
markpub build --help
Markpub website themes
Markpub website themes are managed by the Python package markpub-themes
Management and use of themes is documented there. This package is installed with markpub, and after installation, help information is available:
markpub-themes -h
Documentation
-
Further documentation is under development.
2 maintainers
Release files for markpub 2.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| markpub-2.1.2.tar.gz | 10.0 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| markpub-2.1.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 10.0 MB
Release files / markpub-2.1.2.tar.gz
| Download URL | markpub-2.1.2.tar.gz |
|---|---|
| Size | 10.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
be020cd1b8290522324b18075cabbde988b89a2815515768b6ec9eb4003b279d
|
|
BLAKE2b-256 checksum How to use checksums |
d511644ee95aa49cbdbdc0b76752ad516f3b55173e2dc3fdc4d9a79742b23a48
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.15
|
Release files / markpub-2.1.2-py3-none-any.whl
| Download URL | markpub-2.1.2-py3-none-any.whl |
|---|---|
| Size | 19.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cee3371cbf51c3f19a59de0be57518de5acc3d8ce5ba68511f64ac8566f8fab1
|
|
BLAKE2b-256 checksum How to use checksums |
166c42deaabe2d1a601d3901b790eff097882c204d18ea9ae025e89d51aab53f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.15
|
