Markdown Publisher

Markdown Publisher (md-pub) enables clean, rapid deployment of Markdown content as static HTML via GitHub Actions/Pages. A "keep it simple" alternative to things like Jekyll, Hugo, etc.

Code: https://github.com/chrisdonahue/md-pub

Output: https://chrisdonahue.com/md-pub

Features

• Clean Markdown structure, mirrored 1:1 in HTML
• Uses GitHub Actions to build and deploy the site to GitHub Pages
• Small, hackable JS codebase (see .render directory)
• Arbitrary static assets (images, etc.)
• Multiple pages, directories, relative links and anchors
• YAML frontmatter metadata support
• MIT licensed

Usage instructions

1. Fork the repository (probably change the repo name as well)
2. Go to your repository settings and enable GitHub Pages via GitHub Actions
3. Edit the README.md (or any other markdown file) with your content
4. Edit .render/config.yml to your liking
5. Customize .render/template to your liking
6. Commit and push the changes
7. Wait for the GitHub Actions to build and deploy the site

Testing locally

npm init -y
npm install marked jsdom dompurify js-yaml
node .render/render.js
python3 -m http.server --directory _site 8080

Assets

Put your assets anywhere in the repo and use them as expected: