> **NOTE**: This fork is no longer maintained as there is another actively
> maintained fork https://github.com/liran-funaro/sphinx-markdown-builder,
> please use it instead.
---
# sphinxnotes-markdown-builder
[](https://pypi.org/project/sphinxnotes-markdown-builder)
[](https://pypi.org/project/sphinxnotes-markdown-builder)
[](https://pypi.org/project/sphinxnotes-markdown-builder)
[](https://github.com/sphinx-notes/markdown-builder)
> 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 sphinxnotes-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/sphinx-notes/markdown-builder/issues/new)
## Screenshots
[Contribute](https://github.com/sphinx-notes/markdown-builder/blob/master/CONTRIBUTING.md) a screenshot
## Contributing
Review the [guidelines for contributing](https://github.com/sphinx-notes/markdown-builder/blob/master/CONTRIBUTING.md)
## License
[MIT License](https://github.com/sphinx-notes/markdown-builder/blob/master/LICENSE)
[Jam Risser](https://codejam.ninja) © 2018
## Changelog
Review the [changelog](https://github.com/sphinx-notes/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
* [Shengyu Zhang](https://silverrainz.me) - Current maintainer
Raw data
{
"_id": null,
"home_page": "https://github.com/sphinx-notes/markdown-builder",
"name": "sphinxnotes-markdown-builder",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "sphinx docs documentation markdown",
"author": "Shengyu Zhang",
"author_email": "jam@codejam.ninja",
"download_url": "https://files.pythonhosted.org/packages/fe/75/cb8db5a62f39dd5d05210dafea1364fdbe49750839e10cdc9c122b34bfca/sphinxnotes-markdown-builder-0.5.7.tar.gz",
"platform": null,
"description": "> **NOTE**: This fork is no longer maintained as there is another actively\n> maintained fork https://github.com/liran-funaro/sphinx-markdown-builder,\n> please use it instead.\n\n---\n\n# sphinxnotes-markdown-builder\n\n[](https://pypi.org/project/sphinxnotes-markdown-builder)\n[](https://pypi.org/project/sphinxnotes-markdown-builder)\n[](https://pypi.org/project/sphinxnotes-markdown-builder)\n[](https://github.com/sphinx-notes/markdown-builder)\n\n> sphinx builder that outputs markdown files\n\nPlease \u2605 this repo if you found it useful \u2605 \u2605 \u2605\n\nIf you want frontmatter support please use [sphinx-jekyll-builder](https://github.com/codejamninja/sphinx-jekyll-builder)\n\n\n## Built by Silicon Hills LLC\n\n[](https://nuevesolutions.com)\n\nSilicon Hills offers premium Node and React develpoment and support services. Get in touch at [nuevesolutions.com](https://nuevesolutions.com).\n\n\n## Recommended Projects\n\n* [sphinx-markdown-parser](https://github.com/codejamninja/sphinx-markdown-parser) - write markdown inside of docutils & sphinx projects\n\n\n## Features\n\n* Generates markdown\n\n\n## Installation\n\n```sh\npip3 install sphinxnotes-markdown-builder\n```\n\n\n## Dependencies\n\n* [Python 3](https://www.python.org)\n\n\n## Usage\n\nBuild markdown files with Makefile\n\n```sh\nmake markdown\n```\n\nBuild markdown files with `sphinx-build` command\n\n```sh\ncd docs\nsphinx-build -M markdown ./ build\n```\n\n\n## Support\n\nSubmit an [issue](https://github.com/sphinx-notes/markdown-builder/issues/new)\n\n\n## Screenshots\n\n[Contribute](https://github.com/sphinx-notes/markdown-builder/blob/master/CONTRIBUTING.md) a screenshot\n\n\n## Contributing\n\nReview the [guidelines for contributing](https://github.com/sphinx-notes/markdown-builder/blob/master/CONTRIBUTING.md)\n\n\n## License\n\n[MIT License](https://github.com/sphinx-notes/markdown-builder/blob/master/LICENSE)\n\n[Jam Risser](https://codejam.ninja) \u00a9 2018\n\n\n## Changelog\n\nReview the [changelog](https://github.com/sphinx-notes/markdown-builder/blob/master/CHANGELOG.md)\n\n\n## Credits\n\n* [Jam Risser](https://codejam.ninja) - Author\n* [Matthew Brett](https://github.com/matthew-brett/nb2plots/blob/master/nb2plots/doctree2md.py) - doctree2md\n* [Shengyu Zhang](https://silverrainz.me) - Current maintainer\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "sphinx builder that outputs markdown files, an active fork of clayrisser/sphinx-markdown-builder",
"version": "0.5.7",
"project_urls": {
"Homepage": "https://github.com/sphinx-notes/markdown-builder"
},
"split_keywords": [
"sphinx",
"docs",
"documentation",
"markdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "941a379ffb196cb026c7d7bbe459f462bf12b482b75abe9405f81dea16c1d612",
"md5": "849b75ea8cd49d38ee349db695649a70",
"sha256": "e1c49c31f72c36b29defc69fb05b7087b736355474b8806c814306ad3b42e2b8"
},
"downloads": -1,
"filename": "sphinxnotes_markdown_builder-0.5.7-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "849b75ea8cd49d38ee349db695649a70",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 18606,
"upload_time": "2023-12-24T03:37:42",
"upload_time_iso_8601": "2023-12-24T03:37:42.292529Z",
"url": "https://files.pythonhosted.org/packages/94/1a/379ffb196cb026c7d7bbe459f462bf12b482b75abe9405f81dea16c1d612/sphinxnotes_markdown_builder-0.5.7-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fe75cb8db5a62f39dd5d05210dafea1364fdbe49750839e10cdc9c122b34bfca",
"md5": "1f24098a877c9605d84d08bc4b5284bf",
"sha256": "ad3e88fa1052d1a9bc4b75d7ae389ce51ffa896963bb19643e01b9120ca17ee9"
},
"downloads": -1,
"filename": "sphinxnotes-markdown-builder-0.5.7.tar.gz",
"has_sig": false,
"md5_digest": "1f24098a877c9605d84d08bc4b5284bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17901,
"upload_time": "2023-12-24T03:37:44",
"upload_time_iso_8601": "2023-12-24T03:37:44.053101Z",
"url": "https://files.pythonhosted.org/packages/fe/75/cb8db5a62f39dd5d05210dafea1364fdbe49750839e10cdc9c122b34bfca/sphinxnotes-markdown-builder-0.5.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-24 03:37:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sphinx-notes",
"github_project": "markdown-builder",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "sphinxnotes-markdown-builder"
}
JSON
