# Common-Lisp.net site generator ## Directory structure The source code for the site generator is located in the root of the repository. The `t/` directory contains tests for the site generator. The site content is divided over the directories `content/` and `layout`. The `layout/` directory holds all content that applies to more than one page (e.g. templates) and everything that's referenced from such components (e.g. logo and other images or CSS), or is used to override such a component (e.g. a template which overrides the default template). Referred content, such as stylesheets, scripts and images are located in `layout/static/*`. The `content/` directory holds the individual content items (pages) and everything that's referred from that content, but not referred from layout content. E.g. the `index.html` page - defining the site's front page - is located in `content/` as well as any images that are included on the front page but not included on any template content. Referred content, such as stylesheets, scripts and images are located in `content/static/*` The `content/` directory can contain both `html` files and `lisp` files. `html` files are processed with the template stuff directly into the `output/` directory. `lisp` files are expected to have a call to `cl-site:add-content` as their toplevel form, which takes arguments of `:headers-plist` and `html-string`. See `content/about.lisp` for a reference example. If a file by the same name is stored in both `layout/static/` and `content/static/`, then the one in `layout/static/` takes precedence. ## Dependencies * CL-MUSTACHE for HTML templating * CL-YAML for YAML "header" parsing * CLOSER-MOP (because...?) * CL-WHO for LHTML processing * MARKDOWN.CL for Markdown processing (these are all called out in the cl-site.asd file and will be fetched automatically by Quicklisp) ## Execution ### From command line (recommended) Using Make. The Makefile contains various useful commands. Among them: * `make` - to generate the site. * `make serve` - to run a simple site server (needs python) * `make clean` - to remove the generated files from output directory ### From Lisp ### (The following assumes you have a reasonably recent Quicklisp loaded) Either (in one fell swoop): (load ".../cl-site/build.lisp") ;; replace with your actual path to cl-site/ Or (step by step): First, make sure your `cl-site/` directory (the directory containing this file) is pushed onto `ql:*local-project-directories*` or you have this directory moved or linked under your `quicklisp/local-projects/` directory (see `build.lisp` for example of how to push onto `ql:*local-project-directories*`). Then, load the system with this command: (ql:quickload :cl-site) To generate the site: (cl-site:make-site) The output files will be generated in the `output/` directory. To clean any old files from output/ directory: (cl-site:make-clean)