MyST-Parser VS Python-Markdown

Sphinx along with MyST-parser to write documentation in markdown. I recently discovered portray which seems like a nice alternative as it supports markdown by default for both generic documentation and docstring in modules, class, methods and functions.

https://github.com/executablebooks/myst-parser :

> MyST is a rich and extensible flavor of Markdown meant for technical documentation and publishing.

> MyST is a flavor of markdown that is designed for simplicity, flexibility, and extensibility. This repository serves as the reference implementation of MyST Markdown, as well as a collection of tools to support working with MyST in Python and Sphinx. It contains an extended CommonMark-compliant parser using markdown-it-py, as well as a Sphinx extension that allows you to write MyST Markdown in Sphinx.

https://markdown-it-py.readthedocs.io/en/latest/ :

> *Follows the CommonMark spec for baseline parsing;

This project is just the first step towards making Spyder an educational tool. In the future, we hope that we can develop the infrastructure necessary to support in-IDE tutorials, by improving the tools like Jupyter Book, sphinx-thebe, MyST-Parser which will provide better integration to write educational tutorials.

AutoPyTabs allows you to write code examples in your documentation targeting a single version of Python and then generates examples targeting higher Python versions on the fly, presenting them in tabs, using popular tabs extensions. This all comes packaged as a markdown extension, MkDocs plugin and a Sphinx, so it can easily be integrated with your documentation workflow.

As a starting point, take a look at the Python-Markdown library. It's available from the Pypi repository, so is easy to install with pip / pipenv / ...

Issue Markdown Full Markdown Support Complete Markdown Support with the Help of Python-Markdown/markdown I wanted to finally Add full markdown support.

I like the simplicity of your platform!

Thanks for the bug report. I've used python-markdown [0] for the markdown parsing–I'll have to double-check the implementation.

[0]: https://python-markdown.github.io/

I believe a lot of the actual replacements (or at least mappings to replacements) are happening in inlinepatterns.py - you can see on lines 106-172 all of the regex patterns that are used for various matches. Line 442 you can see the Processor that was created to handle Asterisks, working with and .

I see the https://github.com/Python-Markdown/markdown , but I am troubling identifying the supporting code that really is doing the leg work ie the core functions and logic supporting it to take markdown and turn it in to html.

Interesting, I also use markdown, but hadn't heard of Django-Markdownx before your today. What I do is create two fields: body_md and body_html, and on save use Python Markdown to turn my markdown in html.

Now we have to add a configuration file for the spelling checker. It uses PySpelling under the hood. When checking Markdown files, it first converts a Markdown text file's buffer using Python Markdown and returns a single SourceText object containing the text as HTML. Then it captures the HTML content, comments, and even attributes and performs the check. It has a lot of configuration options, but here we are going to see only an example with some basics. For further info you can read the docs of the rojopolis/spellcheck-github-actions Github action.

Otherwise, I would use markdown with Python Markdown.

To resolve the above issue, I thought the best approach was to avoid reinventing the wheel and save myself hours of debugging: use a third-party library. After implementing a Python implementation of John Gruber’s Markdown, 36 lines of code were cut down to a single function call. I've not benchmarked my SSG after the change, but in terms of code readability, it's certainly worth the overhead caused by the library.