https://github.com/clayrisser/sphinx-markdown-builder
DISCONTINUED: sphinx builder that outputs markdown files. The active version of this project is now being maintained at liran-funaro/sphinx-markdown-builder.
https://github.com/clayrisser/sphinx-markdown-builder
build builder code generator markdown md output sphinx
Last synced: 4 months ago
JSON representation
DISCONTINUED: sphinx builder that outputs markdown files. The active version of this project is now being maintained at liran-funaro/sphinx-markdown-builder.
- Host: GitHub
- URL: https://github.com/clayrisser/sphinx-markdown-builder
- Owner: clayrisser
- License: mit
- Archived: true
- Created: 2018-11-11T00:07:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-06-24T21:25:39.000Z (almost 2 years ago)
- Last Synced: 2025-01-19T19:57:35.012Z (4 months ago)
- Topics: build, builder, code, generator, markdown, md, output, sphinx
- Language: Python
- Homepage: https://bitspur.com
- Size: 94.7 KB
- Stars: 162
- Watchers: 7
- Forks: 66
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- best-of-python-dev - GitHub
README
# sphinx-markdown-builder
---
**DISCONTINUED**: This project is no longer maintained. The active version of this project is now being maintained at [liran-funaro/sphinx-markdown-builder](https://github.com/liran-funaro/sphinx-markdown-builder).
---
[](https://pypi.org/project/sphinx-markdown-builder)
[](https://pypi.org/project/sphinx-markdown-builder)
[](https://pypi.org/project/sphinx-markdown-builder)
[](https://github.com/codejamninja/sphinx-markdown-builder)
[](https://liberapay.com/codejamninja/donate)
[](https://liberapay.com/codejamninja/donate)
> sphinx builder that outputs markdown files
Please ★ this repo if you found it useful ★ ★ ★
If you want frontmatter support please use [sphinx-jekyll-builder](https://github.com/codejamninja/sphinx-jekyll-builder)
## Built by Silicon Hills LLC
[](https://nuevesolutions.com)
Silicon Hills offers premium Node and React develpoment and support services. Get in touch at [nuevesolutions.com](https://nuevesolutions.com).
## Recommended Projects
* [sphinx-markdown-parser](https://github.com/codejamninja/sphinx-markdown-parser) - write markdown inside of docutils & sphinx projects
## Features
* Generates markdown
## Installation
```sh
pip3 install sphinx-markdown-builder
```
## Dependencies
* [Python 3](https://www.python.org)
## Usage
Build markdown files with Makefile
```sh
make markdown
```
Build markdown files with `sphinx-build` command
```sh
cd docs
sphinx-build -M markdown ./ build
```
## Support
Submit an [issue](https://github.com/codejamninja/sphinx-markdown-builder/issues/new)
## Screenshots
[Contribute](https://github.com/codejamninja/sphinx-markdown-builder/blob/master/CONTRIBUTING.md) a screenshot
## Contributing
Review the [guidelines for contributing](https://github.com/codejamninja/sphinx-markdown-builder/blob/master/CONTRIBUTING.md)
## License
[MIT License](https://github.com/codejamninja/sphinx-markdown-builder/blob/master/LICENSE)
[Jam Risser](https://codejam.ninja) © 2018
## Changelog
Review the [changelog](https://github.com/codejamninja/sphinx-markdown-builder/blob/master/CHANGELOG.md)
## Credits
* [Jam Risser](https://codejam.ninja) - Author
* [Matthew Brett](https://github.com/matthew-brett/nb2plots/blob/master/nb2plots/doctree2md.py) - doctree2md
## Support on Liberapay
A ridiculous amount of coffee ☕ ☕ ☕ was consumed in the process of building this project.
[Add some fuel](https://liberapay.com/codejamninja/donate) if you'd like to keep me going!
[](https://liberapay.com/codejamninja/donate)
[](https://liberapay.com/codejamninja/donate)