summaryrefslogtreecommitdiff
path: root/content
diff options
context:
space:
mode:
Diffstat (limited to 'content')
-rw-r--r--content/contributing.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/content/contributing.md b/content/contributing.md
index 5d34f7f..c88fa09 100644
--- a/content/contributing.md
+++ b/content/contributing.md
@@ -20,4 +20,16 @@ This page may change in the future.
The source code for the site is available [here](https://git.marx.cafe/site/).
-If you're familiar with [git](https://git-scm.com/), you can send your changes as a patch to `patch[@]marx.cafe`.
+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.
+
+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.
+
+New pages should be created using `hugo new` so they have the correct front matter variables.
+
+Please don't add images to the site. The goal is to keep it as lean as possible.
+
+If you're familiar with [git](https://git-scm.com/), you can send your changes or additions as a patch to `patch|at|marx.cafe`. [git send-email](https://git-send-email.io/) may be used to help streamline this process.
+
+If you have any questions you can always reach out to `help|at|marx.cafe`.