summaryrefslogtreecommitdiff
path: root/content/contributing.md
blob: c88fa09efb6113cf17f60ed711877046adb18b43 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
---
title: "Contributing"
date: 2022-12-10T16:19:33-05:00
draft: false
weight: 99

author:
written:
firstPublished:
source:
translated:
transcription:
proofed:
copyleft:
---

# Contributing

This page may change in the future.

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.

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`.