A very simple static website generator tool powered by Python, Markdown (but can be extended to other markup)
- Python 3 (python-markdown, shutil)
If you want to build the documentation, you will have to install Sphinx as well.
It's terrible and it doesn't have a profitable and pragmatic usecase in mind, but it works okay. For my needs, anyway. It's alright for simple blogs with no tagging and very simple static websites.
-
After cloning/downloading this repo (extracting it to a folder called
MDiocre), create a work folder adjacent to that folder. Let's call itwork. -
Make a file called
template.htmlinside that folder with these contents:<html> <head>Welcome to my website!</head> <body><!--:content--></body> </html> -
Create a folder called
src, and make a file inside of it calledindex.md, and write anything on it. -
After your content (or before, it doesn't matter), add:
<!--:mdiocre-template="../template.html"--> -
Go back a level to your
workfolder. Assuming Python is present in your PATH (environment variable), create a new text document containing:python3 ../MDiocre/mdiocre.py src buildSave it inside the folder as a .bat if you're on Windows, or as a .sh if you're on Mac, Linux, or other Unix-like systems. Double click or execute it.
-
Check the
buildfolder.
MDiocre allows setting variables. These variables are per-page, and can be read by the template. Both the template and the markdown page share the same format for templates - which are HTML comments with the first character after the markup being the colon (:)
Setting a variable to a string
<!--: hello = "test message" -->
Simply sets hello to test message. When using a comma, make sure to escape it with \!
Setting a variable to another variable
<!--: hello = lemons -->
If lemons is 1 then hello will also be 1. If lemons is not set, hello will contain the string lemons.
Concatenating two or more variables
<!--: lemons = hello, hello -->
If hello contains abc then lemons will contain abcabc. However, if you also include a space string in between, like this...
<!-- lemons = hello, " ", hello -->
lemons will contain abc abc!