From 6902af29eff9d273810bc7d220156912d25ba1ac Mon Sep 17 00:00:00 2001 From: Masataro Asai Date: Sun, 27 Oct 2019 12:40:45 -0400 Subject: [PATCH 1/9] [ci skip] [README] simplified / remove absolute url --- README.md | 58 +++++------------------------------------- docs/content-format.md | 26 +++++++++++++++++++ docs/deploy.md | 13 ++++++++++ 3 files changed, 45 insertions(+), 52 deletions(-) create mode 100644 docs/content-format.md create mode 100644 docs/deploy.md diff --git a/README.md b/README.md index e330f58..bee5a66 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,8 @@ testing is primarily done on [SBCL](http://www.sbcl.org/) and [CCL](http://ccl.c * Git for storage * 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 | |--------------------------------------------------------|----------------------------------------------|-------------------------------------------------------| @@ -107,63 +108,16 @@ $ coleslaw watch-preview (coleslaw-cli:watch) ;; watch-preview does not work on REPL right now ``` -For further customization, edit the `.coleslawrc` file generated by `coleslaw setup`. -Consult the [config docs](https://github.com/redline6561/coleslaw/blob/master/docs/config.md). +For further customization, e.g. adding a new plugin, developing a new plugin, changing the deploy option, or creating a new theme, +see the [config docs](docs). -## 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. - -## Theming - -Two themes are provided: hyde, the default, and readable (based on +We provide three default themes: hyde, the default, and readable (based on [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 hack on and extend. If you want to understand the internals and bend *coleslaw* to do new and interesting things, I strongly encourage you to read the [Hacker's Guide to Coleslaw][hackers]. You'll find some current **TODO** items towards the bottom. -[hackers]: https://github.com/redline6561/coleslaw/blob/master/docs/hacking.md +[hackers]: docs/hacking.md diff --git a/docs/content-format.md b/docs/content-format.md new file mode 100644 index 0000000..c48bab5 --- /dev/null +++ b/docs/content-format.md @@ -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. diff --git a/docs/deploy.md b/docs/deploy.md new file mode 100644 index 0000000..3acecb1 --- /dev/null +++ b/docs/deploy.md @@ -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 From 6fdeb58f63d377adeff12bfcd516b6778c41e923 Mon Sep 17 00:00:00 2001 From: Masataro Asai Date: Sun, 27 Oct 2019 12:48:49 -0400 Subject: [PATCH 2/9] [ci skip] [README] fix travis badge --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bee5a66..520fd67 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # coleslaw -[![Build Status](https://travis-ci.org/kingcons/coleslaw.svg?branch=master)](https://travis-ci.org/kingcons/coleslaw) +[![Build Status](https://travis-ci.org/coleslaw-org/coleslaw.svg?branch=master)](https://travis-ci.org/kingcons/coleslaw) [![Quicklisp](http://quickdocs.org/badge/coleslaw.svg)](http://quickdocs.org/coleslaw/) coleslaw logo From 6e0684b128403bf86d99717d796f053c583004ec Mon Sep 17 00:00:00 2001 From: Masataro Asai Date: Sun, 27 Oct 2019 13:39:09 -0400 Subject: [PATCH 3/9] [ci skip] minor help message --- cli/cli.lisp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cli/cli.lisp b/cli/cli.lisp index b148beb..609a10e 100644 --- a/cli/cli.lisp +++ b/cli/cli.lisp @@ -126,7 +126,7 @@ Excerpt separator is `` by default. (progn (when path (setf *default-pathname-defaults* (truename path))) - (format t "~%Starting a Clack server at ~a~%" path) + (format t "~%Starting a Clack server at ~a. Press C-c to stop it~%" path) (clack:clackup (lack:builder :accesslog From 0e4b8d81b0615bb194b29ab9ab2949dad593bec8 Mon Sep 17 00:00:00 2001 From: Masataro Asai Date: Sun, 27 Oct 2019 12:47:54 -0400 Subject: [PATCH 4/9] [travis] install requirements --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index c214342..12f0a01 100644 --- a/.travis.yml +++ b/.travis.yml @@ -11,6 +11,7 @@ env: install: - curl -L https://raw.githubusercontent.com/snmsts/roswell/release/scripts/install-for-ci.sh | sh + - ros install coleslaw cache: directories: From 0e35b72fc29ecd8f716027506d16a7c875b5575d Mon Sep 17 00:00:00 2001 From: Masataro Asai Date: Sun, 27 Oct 2019 13:18:04 -0400 Subject: [PATCH 5/9] [travis] trying IPv4 to test the preview feature --- cli-tests/basic.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cli-tests/basic.sh b/cli-tests/basic.sh index 213a4de..6f2a61a 100755 --- a/cli-tests/basic.sh +++ b/cli-tests/basic.sh @@ -25,9 +25,9 @@ trap "kill $pid; rm -rf $dir" EXIT sleep 3 -wget 127.0.0.1:5000 -O- +wget -4 -O- 127.0.0.1:5000 -! wget 127.0.0.1:5000/nosuchurl -O- +! wget -4 -O- 127.0.0.1:5000/nosuchurl # ( # wget 127.0.0.1:5000/nosuchurl -O- From 017225300229fc2f549d656a815b933c6a7ffaf0 Mon Sep 17 00:00:00 2001 From: Masataro Asai Date: Sun, 27 Oct 2019 13:56:03 -0400 Subject: [PATCH 6/9] [travis] trying curl to test the preview feature --- cli-tests/basic.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cli-tests/basic.sh b/cli-tests/basic.sh index 6f2a61a..70144b7 100755 --- a/cli-tests/basic.sh +++ b/cli-tests/basic.sh @@ -25,9 +25,9 @@ trap "kill $pid; rm -rf $dir" EXIT sleep 3 -wget -4 -O- 127.0.0.1:5000 +curl --fail 127.0.0.1:5000 -! wget -4 -O- 127.0.0.1:5000/nosuchurl +! curl --fail 127.0.0.1:5000/nosuchurl # ( # wget 127.0.0.1:5000/nosuchurl -O- From e7f0d111fc28d4029f815ea6efcbf6c29d335ae1 Mon Sep 17 00:00:00 2001 From: Masataro Asai Date: Sun, 27 Oct 2019 14:00:14 -0400 Subject: [PATCH 7/9] [travis] trying sudo to test the preview feature --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 12f0a01..547ffc2 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,5 +1,5 @@ language: common-lisp -sudo: false +sudo: true env: global: From fbf7bb3c5c746d732ff66578cd57851c48a6a801 Mon Sep 17 00:00:00 2001 From: Masataro Asai Date: Sun, 27 Oct 2019 14:04:01 -0400 Subject: [PATCH 8/9] [travis] remove wget/curl test --- cli-tests/basic.sh | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/cli-tests/basic.sh b/cli-tests/basic.sh index 70144b7..1ed4ce7 100755 --- a/cli-tests/basic.sh +++ b/cli-tests/basic.sh @@ -25,9 +25,11 @@ trap "kill $pid; rm -rf $dir" EXIT sleep 3 -curl --fail 127.0.0.1:5000 - -! curl --fail 127.0.0.1:5000/nosuchurl +# Doesn't run on Travis! +# wget -O- 127.0.0.1:5000 +# ! wget -O- 127.0.0.1:5000/nosuchurl +# curl --fail 127.0.0.1:5000 +# ! curl --fail 127.0.0.1:5000/nosuchurl # ( # wget 127.0.0.1:5000/nosuchurl -O- From 5f32be57f76d157c637e0a0b6da97e6b46683588 Mon Sep 17 00:00:00 2001 From: Masataro Asai Date: Sun, 27 Oct 2019 14:07:05 -0400 Subject: [PATCH 9/9] Revert "[travis] trying sudo to test the preview feature" This reverts commit e7f0d111fc28d4029f815ea6efcbf6c29d335ae1. --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 547ffc2..12f0a01 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,5 +1,5 @@ language: common-lisp -sudo: true +sudo: false env: global: