I created StuffPages as a quick way to publish simple web pages on my web server. Basically, it takes Markdown files from a specified directory, turns them into CSS-styeld HTML files, and saves the output in another specified directory.
Have a look at some examples!
-
Make sure Python 3 (>=3.6) is installed
-
Install pipx
python3 -m pip install --user pipx python3 -m pipx ensurepath -
Install StuffPages
pipx install stuffpages
-
Initialize StuffPages within the directory that contains the Markdown files:
cd /path/to/directory/ stuffpages init -
Adapt
/path/to/directory/_stuffpages/config.pyaccording to your settings:output_diris the name of the directory that will contain the converted HTML filesignore_dirsis a list of (sub)directories (within the directory that contains the Markdown files) to not build pages fromdefaultsare the values to be used when nothing is set in the metadata of the Markdown file:titleis the default title for generated pagesdescriptionis the default description for generated pagesauthoris the default name of the author shown on generaged pagesauthorlinkis the default target the author name links tostyleis a URL or file path for the css style to be usedsettingsis an optional list of the following settings:nonavfor not creating a nav sectionnoheaderfor not creating a header sectionnofooterfor not creating a footer sectionselfcontainedfor having a _resources directory for each page
html_headis a list of lines that are injected in the final HTML output between<head>and</head>html_navis a list of lines that are injected in the final HTML output between<nav>and</nav>html_headeris a list of lines that are injected in the final HTML output between<header>and</header>html_footeris a list of lines that are injected in the final HTML output between<footer>and</footer>pagelisting_formatis a string describing the format for each item in pages listings ([PAGE])breadcrumb_formatis a string describing the format for each item in breadcrumb listings ([BREADCRUMB])extrasis a dictionary with additional modules to be used by the Markdown Python packageextras-configsis a dictionary of configurations for the additional modules
-
Build the HTML pages:
stuffpages build
Each Markdown file, as well as the html_(head|nav|header|footer) in the config file can contain special listings markers:
[TOC]will be replaced by the table of contents[PAGES]will be replaced by a list of pages sorted by title, prepending!(i.e.[!PAGES]) will reverse sort, and appending a defaults/meta data variable name (e.g. Description) will sort by that defaults/meta data (e.g.[PAGES Description])[BREADCRUMB]will be replaced by a breadcrumb trail of links from the current page to the parent page