diff --git a/doc/docs.md b/doc/docs.md new file mode 100644 index 0000000..6a9e4a0 --- /dev/null +++ b/doc/docs.md @@ -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 diff --git a/doc/intro.md b/doc/intro.md deleted file mode 100644 index 0a237da..0000000 --- a/doc/intro.md +++ /dev/null @@ -1,3 +0,0 @@ -# Introduction to website - -TODO: write [great documentation](http://jacobian.org/writing/what-to-write/) diff --git a/src/website/core.clj b/src/website/core.clj index 247b597..200c963 100644 --- a/src/website/core.clj +++ b/src/website/core.clj @@ -1,18 +1,5 @@ -(ns website.core) - -;; 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 +(ns website.core + :require [clojure.java.io :as io]) (defn foo "I don't do a whole lot."