Contributing

Contributing #

This page may change in the future.

The source code for the site is available here.

The website is statically generated using hugo. You can find the quick start guide here.

Currently most texts are copied from the Marxist Internet Archive. First they’re downloaded according to the MIA FAQ, then they’re run through html2md to get a preliminary version of the document. The markdown 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.

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, you can send your changes or additions as a patch to patch|at|marx.cafe. git send-email may be used to help streamline this process.

If you have any questions you can always reach out to help|at|marx.cafe.

  • Copyleft: Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)