Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
Mason Loring Bliss
cl-site
Commits
8ab59c2d
Commit
8ab59c2d
authored
Oct 14, 2018
by
Erik Huelsmann
Browse files
Define the intent of content/ vs layout/
parent
7eb5cde0
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
8ab59c2d
# Common-Lisp.net site generator #
# Common-Lisp.net site generator
## Dependencies
## Directory structure
CL-MUSTACHE for HTML templating
The source code for the site generator is located in the
root of the repository. The
`t/`
directory contains tests
## Execution
for the site generator.
### From command line (recommended) ###
The site content is divided over the directories
`content/`
and
`layout`
.
Using Make.
The
`layout/`
directory holds all content
The Makefile contains various useful commands.
that applies to more than one page (e.g. templates) and
everything that's referenced from such components (e.g.
Among them:
logo and other images or CSS), or is used to override
such a component (e.g. a template which overrides the
*
`make`
- to generate the site.
default template). Referred content, such as stylesheets,
*
`make serve`
- to run a simple site server (needs python)
scripts and images are located in
`layout/static/*`
.
*
`make clean`
- to remove the generated files from output directory
The
`content/`
directory holds the individual content
### From Lisp ###
items (pages) and everything that's referred from that
content, but not referred from layout content. E.g.
Load with this command:
the
`index.html`
page - defining the site's front page
-
is located in
`content/`
as well as any images that
(ql:quickload :cl-site)
are included on the front page but not included on any
template content. Referred content, such as stylesheets,
To generate the site:
scripts and images are located in
`content/static/*`
.
(cl-site::make-site)
If a file by the same name is stored in both
`layout/static/`
and
`content/static/`
, then the one
The output files will be generated in the
`output/`
directory.
in
`layout/static/`
takes precedence.
## Dependencies
*
CL-MUSTACHE for HTML templating
*
CL-YAML for YAML "header" parsing
*
CLOSER-MOP (because...?)
## 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 ###
Load 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.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment