Pandoc

What Pandoc Is

Pandoc is a Linux application for converting documents from one markup format to another.

Visit the Pandoc website http://pandoc.org/

Why Pandoc is Used

• To convert Markdown files to reStructuredText.

How Pandoc is Used

1. Create the Markdown file(s)

2. Install Pandoc

3. Create a docs folder

4. Navigate to the docs folder

5. Put a copy of the modified Sphinx Makefile

6. Put a copy of the modified Sphinx Config (conf.py)

7. Create an index file: index.rs_

   • This is the main page of the documentation and must include a table of contents
   • The file extension is required for non-code based files to work with the modified Sphinx Makefile

8. Link to the converted files within the index file

9. Generate the documenation

   make html