49 lines
1.6 KiB
Markdown
49 lines
1.6 KiB
Markdown
# Anarchy Planet web site
|
|
|
|
This repo includes markdown files for [the Anarchy Planet web
|
|
site](https://anarchyplanet.org/) and tools to generate a static
|
|
HTML site from the source files.
|
|
|
|
You can see this method in action at
|
|
[https://testing.anarchyplanet.org](https://testing.anarchyplanet.org).
|
|
|
|
## Contributing
|
|
|
|
If you are familiar with editing markdown and using git, you should
|
|
already be able to figure out how to contribute.
|
|
|
|
TODO: write docs for someone who's not familiar with editing markdown
|
|
and/or using git.
|
|
|
|
## Dependencies
|
|
|
|
We use [lowdown](https://kristaps.bsd.lv/lowdown/) for markdown
|
|
conversion. See its documentation:
|
|
|
|
* [overview](https://kristaps.bsd.lv/lowdown/)
|
|
* [lowdown(1)](https://kristaps.bsd.lv/lowdown/lowdown.1.html)
|
|
* [lowdown(5)](https://kristaps.bsd.lv/lowdown/lowdown.5.html) which
|
|
describes the lanuage syntax
|
|
|
|
The rest of the heavy lifting is done by a modified version of
|
|
[ssg](https://www.romanzolotarev.com/ssg.html) which is included
|
|
in this source code. ssg requires a POSIX /bin/sh, and awk.
|
|
|
|
## TODOs
|
|
|
|
* [ ] TODO discuss and decide on sections
|
|
- notnull's proposals for the sections are:
|
|
* home
|
|
* projects (not services)
|
|
* webring (instead of 'others')
|
|
* contact (probably just a mailto: link)
|
|
* [ ] write copy for sections
|
|
- What rocinante has done on
|
|
[anarchist news](https://anarchistnews.org/content/anarchy-planet)
|
|
is already pretty great. Maybe these could be more verbose, but
|
|
maybe they are fine the way they are!
|
|
* [ ] add a favicon
|
|
* [ ] use an automatic toc generator
|
|
- and add to Makefile (make toc)
|
|
- see https://github.com/ekalinin/github-markdown-toc
|