diff options
| author | Admin <admin@marx.cafe> | 2022-12-12 14:06:55 -0500 |
|---|---|---|
| committer | Admin <admin@marx.cafe> | 2022-12-12 14:06:55 -0500 |
| commit | 56a88a2c187ca0f2a058cb4c3113c17c27460da7 (patch) | |
| tree | 8818b9d21b2edb5d972827ea9c8aeb4ae782f06d /content | |
| parent | d4313fcd78f8d1ec84e50b9865f0933f0e62f1cb (diff) | |
Add example document
Diffstat (limited to 'content')
| -rw-r--r-- | content/contributing.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/content/contributing.md b/content/contributing.md index 8587977..193c54d 100644 --- a/content/contributing.md +++ b/content/contributing.md @@ -22,7 +22,9 @@ The source code for the site is available [here](https://git.marx.cafe/site/). The website is statically generated using [hugo](https://gohugo.io/). You can find the quick start guide [here](https://gohugo.io/getting-started/quick-start/). -Currently most texts are copied from the [Marxist Internet Archive](https://marxists.org). First they're downloaded according to the [MIA FAQ](https://www.marxists.org/admin/janitor/faq.htm#hdd), then they're run through [html2md](https://git.marx.cafe/site/tree/html2md.rb) to get a preliminary version of the document. The [markdown](https://www.markdownguide.org/cheat-sheet/) is then be cleaned up by hand. There should be no HTML tags in the final document. +Currently most texts are copied from the [Marxist Internet Archive](https://marxists.org). First they're downloaded according to the [MIA FAQ](https://www.marxists.org/admin/janitor/faq.htm#hdd), then they're run through [html2md](https://git.marx.cafe/site/tree/html2md.rb) to get a preliminary version of the document. The [markdown](https://www.markdownguide.org/cheat-sheet/) is then be cleaned up by hand. There should be one document per work, with each chapter represented by a heading. There should be no HTML tags in the final document. + +For an example of what a finished document looks like, see [content/marx/socialism-utopian-and-scientific/_index.md](https://git.marx.cafe/site/tree/content/marx/socialism-utopian-and-scientific/_index.md). The `html2md` tool works very well with some pages, but not with others. The MIA has extremely inconsistent markup which makes it hard to automate consistently. |