Metadata-Version: 2.1
Name: pyscaffoldext-markdown
Version: 0.2
Summary: PyScaffold extension which replaces reStructuredText by Markdown
Home-page: https://github.com/pyscaffold/pyscaffoldext-markdown
Author: Florian Wilhelm
Author-email: florian.wilhelm@gmail.com
License: mit
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown
Provides-Extra: testing
Requires-Dist: pyscaffold (<4.0a0,>=3.1a0)
Requires-Dist: wheel (>=0.31)
Requires-Dist: recommonmark
Provides-Extra: testing
Requires-Dist: pytest; extra == 'testing'
Requires-Dist: pytest-cov; extra == 'testing'

# pyscaffoldext-markdown

PyScaffold extension which replaces [reStructuredText] formatted files 
by [Markdown] format except for Sphinx-related files.

## Usage

Just install this package with `pip install pyscaffoldext-markdown`
and note that `putup -h` shows a new option `--markdown`.
Basically this extension will replace `README.rst` by a proper `README.md` and
activate the support of Markdown files in Sphinx.
Due to limitations of the Markdown syntax compared to reStructuredText, 
the main documentation files still use reStructuredText by default.

Remember to install [wheel] version 0.31 or higher and use [twine] to upload your
package to [PyPI] instead of `python setup.py release` for this to work, e.g.:
```commandline
python setup.py sdist bdist_wheel
twine upload dist/*
```

## Note

This project has been set up using PyScaffold 3.1rc1. For details and usage
information on PyScaffold see https://pyscaffold.org/.

[reStructuredText]: http://docutils.sourceforge.net/rst.html
[Markdown]: https://daringfireball.net/projects/markdown/
[twine]: https://twine.readthedocs.io/
[PyPI]: https://pypi.org/
[wheel]: https://wheel.readthedocs.io/


