/apache-pandoc

Using pandoc to serve .md or .markdown files with apache

Primary LanguagePython

Installation

  • Install pandoc on your system
  • Make sure python is installed
  • Copy the pandoc.conf file to the conf.available folder of your apache server
  • Enable via a2enconf pandoc.conf (if apache 2.2 just copy to conf.d instead)
  • Create a /usr/share/apache-pandoc folder
  • Copy the pandoc.py and the markdown.css files to the /usr/share/apache-pandoc folder
  • Restart your apache server

Usage

  • Copy this file to a folder accessible by apache (i.e. /home/user/public_html)
  • Access http://localhost/~user/README.md with a browser (you will see the html5 version of this file)
  • Access http://localhost/~user/README.html with a browser (you will see the html version of this file)
  • Access http://localhost/~user/README.pdf with a browser (you will see the pdf version of this file)
  • Access http://localhost/~user/README.rtf with a browser (you will see the rtf version of this file)
  • Access http://localhost/~user/README.odt with a browser (you will see the odt version of this file)
  • Access http://localhost/~user/README.raw with a browser (you will see the raw version of this file)

Advanced usage

Create a /home/user/public_html/.apache-pandoc.ini file containing

[Pandoc]
toc=true

And access to http://localhost/~user/README.md with a browser (you will see the html version of this file with a table of contents). A lot of configuration options can be inserted in the .apache-pandoc.ini files. See pandoc.py for more details.

License

apache-pandoc is released under the CeCILL-B license

Authors

  • Christophe Demko