Skip to main content

Command-line utility to split a Markdown file into linked static web pages.

Project description

marksplitz

Command-line utility to split a Markdown file into linked static web pages.

Development work in progress.

Directive Comments

The following HTML comments can be placed in the source Markdown document to alter the generated HTML.

<!-- title: new-title -->

  • Replace the default HTML title for the page.

<!-- class: class-1 class-2 -->

  • Add one or more classes to the content div.
  • Use to apply additional styles via a custom.css file.

Command-line Usage

usage: marksplitz [-h] [-o OUTPUT_DIR] [-n OUTPUT_NAME] [-i IMAGES_SUBDIR]
                     [-c CSS_FILE]
                     markdown_file

Split a Markdown file into linked HTML pages.

positional arguments:
  markdown_file         Path to the Markdown file to split.

options:
  -h, --help            show this help message and exit
  -o OUTPUT_DIR, --output-dir OUTPUT_DIR
                        Path to the output directory.
  -n OUTPUT_NAME, --output-name OUTPUT_NAME
                        Base name for the output HTML files.
  -i IMAGES_SUBDIR, --images-subdir IMAGES_SUBDIR
                        Subdirectory for images. Expected to be in the
                        directory containing the Markdown file. Contents are
                        copied to a subdirectory by the same name in the
                        output directory.
  -c CSS_FILE, --css-file CSS_FILE
                        Optional name of a CSS file to include in the same
                        location as the HTML output. If a CSS file is not
                        specified, a default style is embedded in the HTML
                        output. If a CSS file is specified, the default style
                        is not included.If the specified CSS file does not
                        exist, it is created with the default style.

Reference

CSS

Customizing the generated HTML output requires using CSS.

Packages Used

Project Tools

  • uv - Environment management (in place of pip)
  • Ruff - Linter and code formatter
  • pytest - Testing framework
  • build - Python packaging build frontend
  • twine - Utility for publishing Python packages
  • Just - Command runner

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

marksplitz-0.1.dev12.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

marksplitz-0.1.dev12-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file marksplitz-0.1.dev12.tar.gz.

File metadata

  • Download URL: marksplitz-0.1.dev12.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for marksplitz-0.1.dev12.tar.gz
Algorithm Hash digest
SHA256 42ef1334dd6d15dce8dee0ce87dd8a93a3d7d64f52ce8cd72db7630d8c215241
MD5 7a2ee6900962b312efa8fe5ff6549d0e
BLAKE2b-256 d89879bb6b43dd0b2a485634c764ff73fc15917516dc7f01b9e85261cba85aaa

See more details on using hashes here.

File details

Details for the file marksplitz-0.1.dev12-py3-none-any.whl.

File metadata

  • Download URL: marksplitz-0.1.dev12-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for marksplitz-0.1.dev12-py3-none-any.whl
Algorithm Hash digest
SHA256 5fa72bda6eb2fd842f815f5e19c0287bb55262bd06866709ea2045f50a04422a
MD5 d005322a7cff267d1cce119ae9451bcf
BLAKE2b-256 3b15b966db9aa208f32ba6153fd2894fbc5464748c5c776b64cc4711f515ebf7

See more details on using hashes here.

Supported by

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