77 lines
2.5 KiB
Markdown
77 lines
2.5 KiB
Markdown
This repo is to generate a static site for anarchyplanet.org to
|
|
replace the existing site. The goal is to generate the site from
|
|
markdown files by converting the markdown to html and applying minimal
|
|
styling.
|
|
|
|
The advantage to this method is that all of the content can be
|
|
contained in a single directory without being obscured by the rest of
|
|
the code that's needed to make a website run (such as html). This will
|
|
(eventually!) make it easy to update content as well as export into
|
|
other formats or potential website generators.
|
|
|
|
This informal README will be replaced with an official README with
|
|
instructions for how to contribute to the site, but first we have to
|
|
figure out how ourselves! All methods are also open for discussion,
|
|
the only requirement that notnull hopes for is pure markdown files in
|
|
a single directory, but sceox is welcome to change publish.sh to a
|
|
make script. :)
|
|
|
|
You can see this method in action (maybe! if we didn't break it) at
|
|
[https://testing.anarchyplanet.org](https://testing.anarchyplanet.org) and [https://testing.anarchyplanet.org/webring.html](https://testing.anarchyplanet.org/webring.html).
|
|
|
|
|
|
# TODOs
|
|
|
|
## TODO choose a markdown converter (or a method to fix discount's shortcomings)
|
|
|
|
We are currently using
|
|
[discount](http://www.pell.portland.or.us/~orc/Code/markdown/),
|
|
however discount 2.2.2 (included in Debian repos) is not properly
|
|
handling the conversion of anchor links (not a deal breaker but not
|
|
great). For example, it converts:
|
|
|
|
```markdown
|
|
Anarchy Planet Sites{#planet}
|
|
--------------------
|
|
```
|
|
|
|
to:
|
|
|
|
```html
|
|
<li><a href="#planet">Anarchy Planet Sites</a></li>
|
|
```
|
|
|
|
when it should convert it to:
|
|
|
|
```html
|
|
<h2 id="planet">Anarchy Planet Sites</h2>
|
|
```
|
|
|
|
Pandoc handles this perfectly; however it is a large package with many
|
|
features we don't need. However, one advantage to pandoc is that it
|
|
can also handle .muse files :)
|
|
|
|
## TODO fix up publish.sh
|
|
|
|
notnull's bash scripting skills are severely lacking, but the general
|
|
logic is there. In particular, we need to figure out how to insert
|
|
text from nav.html after the first `<body>` tag.
|
|
|
|
## 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)
|
|
|
|
## TODO 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!
|
|
|
|
## TODO we need a favicon
|