OpenBASED

mdhtml

Tiny script (~1kb) for building static websites from markdown files

Source code available here

Requirements

By default, mdhtml uses multimarkdown for markdown processing. Feel free to change this inside the script file itself.

Any projects using mdhtml will also be required to have the following setups:

• public and assets folders
• _header.html and _footer.html files
• Markdown files contain an h1 heading on the first line

The contents (both files and folders) of the assets directory will be carried over into the public folder at build time. Markdown files will be converted and their sub-directories carried over.

Most files and assets are compressed (gzip) by default. You can remove this line from the core script if you desire.

Usage

1. Clone this project and set mdhtml as executable: chmod +x mdhtml
2. Create your desired website pages as markdown files in the root directory
3. Run mdhtml inside the same root directory
4. Core website files will be written into the public directory
5. Place public folder contents on your web server!

Support OpenBSD

If you've found anything on this website helpful please consider donating directly to the OpenBSD Project.

A little goes a long way, and the OpenBSD Project is a volunteer-driven software group funded by donations!