36 lines
1.1 KiB
Markdown
36 lines
1.1 KiB
Markdown
# Documentation
|
|
|
|
I'm chucking everything I need in here until I know what I actually want
|
|
|
|
MVP:
|
|
- Parse templated HTML pages into a navigable website
|
|
- Parse markdown into HTML blog posts
|
|
- Parse YAML headers for date and project
|
|
- Deployed and running
|
|
|
|
Backlog:
|
|
- Configure various dirs via TOML file
|
|
- Define some nice variables for more templating
|
|
- Handles images in markdown posts
|
|
- Automatically re-deploys when new content is pushed
|
|
- Make it look pretty
|
|
- Ability to link blogs covering the same project automatically
|
|
|
|
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
|