marcuskammer/coleslaw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[ci skip] [README] simplified / remove absolute url

Browse source
This commit is contained in:
Masataro Asai 2019-10-27 12:40:45 -04:00
parent d7a4433523
commit 6902af29ef
3 changed files with 45 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
README.md
View file

@ -25,7 +25,8 @@ testing is primarily done on [SBCL](http://www.sbcl.org/) and [CCL](http://ccl.c
* Git for storage * Git for storage
* RSS/Atom feeds * RSS/Atom feeds
* A [Plugin API](http://github.com/redline6561/coleslaw/blob/master/docs/plugin-api.md) and [**plugins**](http://github.com/redline6561/coleslaw/blob/master/docs/plugin-use.md) for... * Themes
* A [Plugin API](docs/plugin-api.md) and [**plugins**](docs/plugin-use.md) for...
| plugins | plugins | plugins | | plugins | plugins | plugins |
|--------------------------------------------------------|----------------------------------------------|-------------------------------------------------------| |--------------------------------------------------------|----------------------------------------------|-------------------------------------------------------|
@ -107,63 +108,16 @@ $ coleslaw watch-preview
(coleslaw-cli:watch) ;; watch-preview does not work on REPL right now (coleslaw-cli:watch) ;; watch-preview does not work on REPL right now
``` ```
For further customization, edit the `.coleslawrc` file generated by `coleslaw setup`. For further customization, e.g. adding a new plugin, developing a new plugin, changing the deploy option, or creating a new theme,
Consult the [config docs](https://github.com/redline6561/coleslaw/blob/master/docs/config.md). see the [config docs](docs).
## The Content Format We provide three default themes: hyde, the default, and readable (based on
Coleslaw expects content to have a file extension matching the class
of the content. (I.e. `.post` for blog posts, `.page` for static pages, etc.)
There should also be a metadata header on all files
starting and ending with the config-specified `:separator`, ";;;;;" by
default. Example:
```
;;;;;
title: foo
tags: bar, baz
date: yyyy-mm-dd hh:mm:ss
format: html (for raw html) or md (for markdown)
excerpt: Can also be extracted from content (see :excerpt-sep config param)
;;;;;
your post
```
Posts require the `title:` and `format:` fields.
Pages require the `title:` and `url:` fields.
To omit a field, simply do not have the line present, empty lines and
fields (e.g. "tags:" followed by whitespace) will be ignored.
## Theming
Two themes are provided: hyde, the default, and readable (based on
[bootswatch readable](http://bootswatch.com/readable/)). [bootswatch readable](http://bootswatch.com/readable/)).
A guide to creating themes for coleslaw lives
[here](https://github.com/redline6561/coleslaw/blob/master/docs/themes.md).
## Deploying on a standalone server
Coleslaw can deploy to a standalone server.
If you want this server installation, initialize a bare git repo and
set up the post-receive hook on that repo.
* First initialize a [git bare repo](http://git-scm.com/book/en/Git-on-the-Server-Setting-Up-the-Server) on the server.
* Copy [example post-receive hook][post_hook] to your blog's bare repo and set the executable bit (`chmod +x`).
* Point the web server at `:deploy-dir` attribute on the config file.
Or "deploy-dir/.curr" if the `versioned` plugin is enabled.
[post_hook]: https://github.com/redline6561/coleslaw/blob/master/examples/example.post-receive
## Hacking
A core goal of *coleslaw* is to be both pleasant to read and easy to A core goal of *coleslaw* is to be both pleasant to read and easy to
hack on and extend. If you want to understand the internals and bend hack on and extend. If you want to understand the internals and bend
*coleslaw* to do new and interesting things, I strongly encourage you *coleslaw* to do new and interesting things, I strongly encourage you
to read the [Hacker's Guide to Coleslaw][hackers]. You'll find some to read the [Hacker's Guide to Coleslaw][hackers]. You'll find some
current **TODO** items towards the bottom. current **TODO** items towards the bottom.
[hackers]: https://github.com/redline6561/coleslaw/blob/master/docs/hacking.md [hackers]: docs/hacking.md

26
docs/content-format.md Normal file
View file

@ -0,0 +1,26 @@
# The Content Format
Coleslaw expects content to have a file extension matching the class
of the content. (I.e. `.post` for blog posts, `.page` for static pages, etc.)
There should also be a metadata header on all files
starting and ending with the config-specified `:separator`, ";;;;;" by
default. Example:
```
;;;;;
title: foo
tags: bar, baz
date: yyyy-mm-dd hh:mm:ss
format: html (for raw html) or md (for markdown)
excerpt: Can also be extracted from content (see :excerpt-sep config param)
;;;;;
your post
```
Posts require the `title:` and `format:` fields.
Pages require the `title:` and `url:` fields.
To omit a field, simply do not have the line present, empty lines and
fields (e.g. "tags:" followed by whitespace) will be ignored.

13
docs/deploy.md Normal file
View file

@ -0,0 +1,13 @@
# Deploying on a standalone server
Coleslaw can deploy to a standalone server.
If you want this server installation, initialize a bare git repo and
set up the post-receive hook on that repo.
* First initialize a [git bare repo](http://git-scm.com/book/en/Git-on-the-Server-Setting-Up-the-Server) on the server.
* Copy [example post-receive hook][post_hook] to your blog's bare repo and set the executable bit (`chmod +x`).
* Point the web server at `:deploy-dir` attribute on the config file.
Or "deploy-dir/.curr" if the `versioned` plugin is enabled.
[post_hook]: https://github.com/redline6561/coleslaw/blob/master/examples/example.post-receive