maze88.dev Static site & generator

Overview

This repository contains the sources and static files (on branches main and pages, respectfully) for generating my website/blog https://maze88.dev using my SSG. Deployment is with Codeberg pages.

Input preparation

1. All content should be written in markdown and put in the src/ directory.

   Note: Do not create a src/blog.md file, since the build will overwrite it when generating the blog index.

2. Blog posts should be placed in the src/posts/ directory, with filenames that are arranged chronologically by prefix (using numbers and dashes only), such as:

   00-writing-markdown.md
   01-generating-html.md
   

   or

   2022-01-11-writing-markdown.md
   2022-02-22-generating-html.md
   

3. Each post should contain the following YAML in its frontmatter:

   ---
   title: Generating HTML with Pandoc
   date: 2022-03-11
   author: Michael Zeevi  # optional
   keywords:  # optional
   - markdown
   - html
   ---
   

4. Additional resources and media (CSS, images, PGP public key, etc.) can be put in the assets/ directory, which will be copied to _dist/assets/ during build.

Usage

Local development and testing

1. Build by running make (which wraps the ./build.sh script) - this will clean and then produce the output in the directory _dist/.

2. One can test by opening the output locally in their web browser.

Publishing (deploying)

1. Run make publish - this will first build and then commit & push the output to the pages branch.

   Note: The pages branch must pre-exist in the remote repository.

2. One can test by going to the website with their browser.

   Note: A .domains file must also exist on the pages branch.