hiro/recommonmark
1
0
Fork 0
mirror of https://github.com/vale981/recommonmark synced 2025-03-06 02:21:38 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #18 from jezdez/patch-2

Browse source 
Unindent code examples in README.
This commit is contained in:
Anthony 2015-10-29 16:57:16 -07:00
commit 29d175c7cb
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -17,19 +17,19 @@ To use `recommonmark` inside of Sphinx only takes 2 steps.
First you install it: First you install it:
``` ```
pip install recommonmark pip install recommonmark
``` ```
Then add this to your Sphinx conf.py: Then add this to your Sphinx conf.py:
``` ```
from recommonmark.parser import CommonMarkParser from recommonmark.parser import CommonMarkParser
source_parsers = { source_parsers = {
'.md': CommonMarkParser, '.md': CommonMarkParser,
} }
source_suffix = ['.rst', '.md'] source_suffix = ['.rst', '.md']
``` ```
This allows you to write both `.md` and `.rst` files inside of the same project. This allows you to write both `.md` and `.rst` files inside of the same project.