PyMdown

NOTE: This project is currently not actively being developed. It may be taken up again in the future, but currently I am not actively using it, so motivation to actively work on this low.

PyMdown is a CLI tool to convert or even batch convert markdown files to HTML. PyMdown has a number of extensions written specifically for it found at this separate repository: pymdown-extensions. PyMdown can also generate HTML previews of markdown and auto-open them in a webbrowser.

Status

This is in a Beta state. Because of the Beta state, things are in flux and are subject to change without warning.

Documentation

Though the documentation is currently still in flux and still being completed, it is found here: PyMdown Documentation

Credits

• Built on top of https://pypi.python.org/pypi/Markdown
• Contains a custom extensions from pymdown-extensions: https://github.com/facelessuser/pymdown-extensions
• Uses Pygments for syntax highlighting of code: http://pygments.org/.
• Inspiration for the project came from https://github.com/revolunet/sublimetext-markdown-preview.

License

MIT license.

Copyright (c) 2014 - 2015 Isaac Muse isaacmuse@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

3rd Party Licenses

See licenses.