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.
- MDN Guide: Learn to style HTML using CSS
- MDN Reference: CSS: Cascading Style Sheets
Packages Used
Project Tools
Project details
Release history Release notifications | RSS feed
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 hashes)
Built Distribution
Close
Hashes for marksplitz-0.1.dev12-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5fa72bda6eb2fd842f815f5e19c0287bb55262bd06866709ea2045f50a04422a |
|
MD5 | d005322a7cff267d1cce119ae9451bcf |
|
BLAKE2b-256 | 3b15b966db9aa208f32ba6153fd2894fbc5464748c5c776b64cc4711f515ebf7 |