doc: Delete intro.md and make a docs.md
Containing all the documentation so far, which is really just me spitballing rubbish into a file.
This commit is contained in:
parent
6a416f652d
commit
d8e278de37
|
@ -0,0 +1,31 @@
|
||||||
|
# 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
|
|
@ -1,3 +0,0 @@
|
||||||
# Introduction to website
|
|
||||||
|
|
||||||
TODO: write [great documentation](http://jacobian.org/writing/what-to-write/)
|
|
|
@ -1,18 +1,5 @@
|
||||||
(ns website.core)
|
(ns website.core
|
||||||
|
:require [clojure.java.io :as io])
|
||||||
;; Requirements:
|
|
||||||
;; - Parse markdown into html content
|
|
||||||
;; - Build templates from html
|
|
||||||
;; - Handle images
|
|
||||||
;; - 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
|
|
||||||
|
|
||||||
(defn foo
|
(defn foo
|
||||||
"I don't do a whole lot."
|
"I don't do a whole lot."
|
||||||
|
|
Loading…
Reference in New Issue