https://github.com/pyscaffold/pyscaffoldext-markdown
⬇️ PyScaffold extension which replaces reStructuredText by Markdown
https://github.com/pyscaffold/pyscaffoldext-markdown
markdown pyscaffold pyscaffold-extension python
Last synced: 3 months ago
JSON representation
⬇️ PyScaffold extension which replaces reStructuredText by Markdown
- Host: GitHub
- URL: https://github.com/pyscaffold/pyscaffoldext-markdown
- Owner: pyscaffold
- License: mit
- Created: 2018-08-23T13:08:52.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-03T17:03:05.000Z (4 months ago)
- Last Synced: 2025-03-28T03:51:13.436Z (3 months ago)
- Topics: markdown, pyscaffold, pyscaffold-extension, python
- Language: Python
- Homepage: https://pyscaffold.org
- Size: 131 KB
- Stars: 13
- Watchers: 2
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Authors: AUTHORS.md
Awesome Lists containing this project
README
[](https://cirrus-ci.com/github/pyscaffold/pyscaffoldext-markdown)
[](https://pyscaffold.org/projects/markdown/en/latest/)
[](https://coveralls.io/r/pyscaffold/pyscaffoldext-markdown)
[](https://pypi.org/project/pyscaffoldext-markdown)
[](https://anaconda.org/conda-forge/pyscaffoldext-markdown)
[](https://pepy.tech/project/pyscaffoldext-markdown)
[](https://github.com/sponsors/FlorianWilhelm)
# pyscaffoldext-markdown
[PyScaffold] extension which replaces [reStructuredText] formatted files
by [Markdown] format (with the help of [MyST]) except for [Sphinx]-related files.
## Usage
Just install this package with either `pip install pyscaffoldext-markdown` or `conda install -c conda-forge 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.
## Building and Releasing
By default, the [tox] configuration generated by [PyScaffold] is compatible
with Markdown (as implemented in this extension). This means that (after
installing [tox] with [pip] or [pipx]) you can run:
```bash
tox -e docs # to build your documentation
tox -e build # to build your package distribution
tox -e publish # to test your project uploads correctly in test.pypi.org
tox -e publish -- --repository pypi # to release your package to PyPI
tox -av # to list all the tasks available
```
Please remember that the command `python setup.py release` is no longer
recommended, so if you don't like [tox], please consider using
[Sphinx] and [twine] directly:
```bash
python -m pip install -U pip setuptools wheel sphinx twine
python setup.py bdist_wheel # to build your package distributions
make -C docs html # to build your docs
twine upload dist/* # to release your package to PyPI
```
## Making Changes & Contributing
This project uses [pre-commit], please make sure to install it before making any
changes:
```bash
pip install pre-commit
cd pyscaffoldext-markdown
pre-commit install
```
It is a good idea to update the hooks to the latest version:
```bash
pre-commit autoupdate
```
Please also check PyScaffold's [contribution guidelines].
## Note
This project has been set up using PyScaffold 4.0. For details and usage
information on PyScaffold see [https://pyscaffold.org/](https://pyscaffold.org/).
[PyScaffold]: https://pyscaffold.org
[reStructuredText]: https://docutils.sourceforge.io/docs/user/rst/quickstart.html
[Markdown]: https://daringfireball.net/projects/markdown/
[MyST]: https://myst-parser.readthedocs.io/en/latest/index.html
[Sphinx]: https://www.sphinx-doc.org/
[WSL]: https://docs.microsoft.com/en-us/windows/wsl/
[tox]: https://tox.readthedocs.org/
[pip]: https://pip.pypa.io/en/stable/
[pipx]: https://pipxproject.github.io/pipx/
[twine]: https://twine.readthedocs.io/
[PyPI]: https://pypi.org/
[Conda-Forge]: https://anaconda.org/conda-forge/pyscaffoldext-markdown
[pre-commit]: https://pre-commit.com/
[contribution guidelines]: https://pyscaffold.org/en/latest/contributing.html