hiltons.xyz/doc/docs.md

950 B

Documentation

I'm chucking everything I need in here until I know what I actually want

Requirements:

  • Parse markdown into html content
  • Build templates from html
  • Handle images
  • Configuration via TOML file
  • Automatically update when new content is pushed
  • Blog framework
    • Ability to link blogs covering the same project automatically
    • Parse YAML headers for date and project

Stack

  • Clojure for the SSB
  • Just HTML/CSS/JS I don't need anything fancy
  • Markdown files in a directory

Layout:

  • site: Contains everything about the site
  • templates: All .template.html files in here are indexed as HTML
  • html: Contains the top-level html files which will become the site
    • This does not include the dynamically generated posts, which will also get included

Templates

  • Standard HTML for the most part.
  • #{{ }} inserts a template file inline
  • ${{ }} inserts a variable defined either as standard or in the TOML