zulip/docs/README.md
Yoyo Zhou 8461048a11 Add 'Code style', generated via pandoc -r mediawiki -w rst and html_unescape.py
With a basic README.md

(imported from commit 91728b2c591bc88b7bee520669cb0b3f53426cd8)
2015-08-18 17:34:02 -07:00

626 B

To create rST from MediaWiki input:

  • Use pandoc -r mediawiki -w rst on MediaWiki source.
  • Use unescape.py to remove any leftover HTML entities (often inside
    tags and the like).

We can use pandoc to translate mediawiki into reStructuredText, but some things need fixing up:

  • Add page titles.
  • Review pages for formatting (especially inline code chunks) and content.
  • Fix wiki links?
  • Add pages to the table of contents (index.rst).

To generate HTML docs locally from RST:

  • pip install sphinx
  • In this directory, make html. Output appears in a _build/html subdirectory.