Skip to content

Commit

Permalink
DOC: Add instructions to install pandoc
Browse files Browse the repository at this point in the history
Closes #72.
  • Loading branch information
mgeier committed Mar 12, 2017
1 parent 487762d commit 7fd1d08
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions doc/usage.jupyter
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,19 @@ markdown
Recent versions of Python already come with `pip` pre-installed.
If you don't have it, you can [install it manually](https://pip.pypa.io/en/latest/installing/).

### pandoc

The stand-alone program [pandoc](http://pandoc.org/) is used to convert Markdown content to something Sphinx can understand. You have to install this program separately, ideally with your package manager. If you are using `conda`, you can select the [conda-forge](https://conda-forge.github.io/) channel to install the [pandoc](https://anaconda.org/conda-forge/pandoc) package.
If that doesn't work out for you, have a look at `pandoc`'s [installation instructions](http://pandoc.org/installing.html).

<div class="alert alert-info">

**Note:**

The use of `pandoc` in `nbsphinx` is temporary, but will likely stay that way for a long time, see [issue #36](https://github.com/spatialaudio/nbsphinx/issues/36).

</div>

### Syntax Highlighting

To get proper syntax highlighting in code cells, you'll need an appropriate *Pygments lexer*.
Expand Down

0 comments on commit 7fd1d08

Please sign in to comment.