https://github.com/chdemko/apache-pandoc

Using pandoc to serve .md or .markdown files with apache
https://github.com/chdemko/apache-pandoc

Last synced: 26 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/chdemko/apache-pandoc
• Owner: chdemko
• Created: 2013-03-04T16:06:46.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2015-01-05T19:20:37.000Z (almost 10 years ago)
• Last Synced: 2024-08-10T14:14:45.707Z (5 months ago)
• Language: Python
• Homepage:
• Size: 150 KB
• Stars: 31
• Watchers: 7
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Installation

============

 * Install [`pandoc`](http://johnmacfarlane.net/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](http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html)

 

 

Authors

=======

 * Christophe Demko