diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..9b29ee6 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Trac Wiki converted to Pelican Markdown + +The Trac Wiki that used to hold this site has been converted to a +wiki-like setup using git, Markdown, Pelican, and m.css. + +* [git repository behind this Wiki](https://git.cryptech.is/wiki). +* [Pelican documentation](https://docs.getpelican.com/en/stable/). +* [m.css documentation](https://mcss.mosra.cz/themes/pelican/). + +The git repository is configured to generate the web content from the +Markdown automatically upon receiving a `git push`. + +[linkchecker](https://linkcheck.github.io/linkchecker/) may also be +useful in validating the generated content. + +The `Makefile` in this directory makes it easy to test out changes to +the content before pushing them, eg: + +``` +make all check server +``` + +will generate the content, run the result through `linkchecker`, then +start up a web server on the name and port specified in the Makefile +(which you can override with the `HTTP_HOST` and `HTTP_PORT` +variables) to let you browse the result. Feel free to experiment on +your own copy: there are almost certainly things we could do better +within the Pelican framework, maybe you'll figure them out for us. + +The upstream repository is configured to run Pelican automatically on +push and install the result, and to refuse the push if something fails +to compile. It is of course possible to mess things up in ways that +won't cause compilation to fail, so don't do that. :) + +As with all Cryptech git repositories, all commits to this repository +must be signed by a known key. |