DIY SSG

Static site generator template/starter that suits my needs. Optimized for flexibility and simplicity. Just Markdown, TypeScript, and JSX. No magic.

Look and feel copied from the Bear Cub theme for Hugo.

Getting Started

pnpm dev

Windows:

pnpm win-dev

Features

• Use Markdown and JSX in the same file.
  • Intended as a first approximation of MDX. See src/content/mdx.tsx.
• Straightforward to convert to a full-fledged web app powered by Hono.
  • DIY SSG uses Hono for JSX. An alternative: Kita.
• More flexible than Hugo.
• Lower-level, less bloat than Astro.
• Tailwind CSS (v3)
• Markdown features:
  • Compile time code highlighting
  • Footnotes
  • HTML in Markdown
  • Front matter

Nota Bene

• Avoid having two files in the src/contents folder with the same basename but different extensions (.md and .tsx). For instance, article.md and article.tsx.
• You might want to disable the sitemap. See src/build.tsx.

Contributing

# Install git hooks
pnpm hooks

# Bypass hooks
git commit -m "commit message" --no-verify # -n for shorthand

See simple-git-hooks.

TODO

• Copy more features from Bear Cub, e.g. social card generation.

Changelog

2025-02-21 v0.3.0

• Switch out formatter for Prettier.

2025-02-21 v0.2.0

• Added Git hooks.
• Added linting.
• Added windows support.
• Assorted minor fixes
• Formatting

2025-02-19 v0.1.0

• Added Tailwind CSS.
• Improved README.
• Simplified the way the static folder works.