README.md 3.04 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
# 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/*`.

20 21
The `content/` directory holds the individual content items (pages)
and everything that's referred from that content, but not referred
22 23
from layout content. E.g.  the `index.html` page — defining the
site's front page — is located in `content/` as well as any images
24 25 26
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/*`
27 28 29 30 31 32 33

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.
34 35 36 37 38 39 40 41 42 43

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...?)
44 45 46 47 48
* 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)
49 50 51

## Execution

52

53
### From command line, using make:
54 55 56 57 58 59 60 61 62 63 64 65

The Makefile contains various useful commands. 

Among them:

* `make` - to generate the site.
* `make serve` - to run a simple site server on port 8008 or subsequent (currently needs Allegro CL, SBCL, or CCL)
* `make clean` - to remove the generated files from output directory
* `make pyserve` - to run a secondary (python) server on port 8000 (crashes if 8000 is busy).


### From Lisp 
66

67
(The following assumes you have a reasonably recent Quicklisp loaded)
68

69
* To generate the static pages:
70

71
     (load ".../cl-site/build.lisp") ;; replace with your actual path to cl-site/
72

73
  This will load the site-generating code and generate the static pages into `output/`
74 75


76
* To generate the static pages and start the test server:
77

78
     (load ".../cl-site/test-serve.lisp") ;; replace with your actual path to cl-site/
79

80 81
 This will start serving the site on port 8008 (or subsequent port
 numbers, if 8008 is busy).
82

83
### Known Problems
84

85 86 87 88
 The test server crashes on load with `invalid number of arguments` on
 certain 1.3.1 releases of SBCL (apparently a problem with the
 `ironclad` library from quicklisp with this sbcl version). If you get
 this error, try upgrading your SBCL or use CCL.
89

90 91 92 93




94