Archived
1
0
Fork
You've already forked pages-ssg
0
My SSG for generating my website/blog content. https://maze88.dev
This repository has been archived on 2025年01月01日. You can view files and clone it, but you cannot make any changes to its state, such as pushing and creating new issues, pull requests or comments.
  • HTML 45%
  • CSS 34.1%
  • Shell 10.1%
  • JavaScript 7.6%
  • Makefile 3.2%
2024年12月20日 10:13:29 +02:00
in add link to ishkur's electronic music guide 2024年12月20日 10:13:29 +02:00
res a souvenir from april fools 2024年04月02日 20:59:18 +03:00
template add liberapay donation link to footer, bump up email in contact method list, add more detail about fond music 2024年01月26日 01:55:02 +00:00
.gitignore merged about and hobbies to single intro/hello page 2022年04月02日 17:33:10 +03:00
build.sh changed publish to give full copy-pastable instructions 2023年01月17日 13:14:55 +02:00
LICENSE add license 2024年01月14日 21:18:37 +00:00
makefile remove mock echo line from development phase 2024年01月27日 13:02:44 +00:00
README.md update usage section to reflect new automation in makefile 2024年01月27日 13:24:28 +00:00

maze88.dev Static site generator

Input preparation

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

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

  2. Blog posts should be placed in the in/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 Pandocdate:11/03/2022author:Michael Zeevi # optionalkeywords:# optional- markdown- html---

  4. Additional resources and media (CSS, images, PGP public key, etc.) can be put in the res/ directory, which will be copied to out/res/ 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 out.

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

Publishing (deploying)

  1. Run make publish - this will first build and copy the output to the ../pages/ directory (repository), and then automatically commit and push (!) to the remote pages repository (thus publishing it).

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