Python Markdown Formatting

Posted on  by



Markdown is a common markup language frequently used by developers to writePython project documention.

  • Rich is a Python library for rich text and beautiful formatting in the terminal.
  • Markdown is a type of markup language often used to document Python projects. Learn more about Markdown on Full Stack Python.

Markdown's origin

Python Markdown Formatting Tutorial

Markdown was originallydeveloped by John Gruberin 2004. The markup language's lightweight design helped it gain rapidadoption by software developers and designers. The format's simplicity alsomakes it easier to write parsers to convert the structured syntax intoother formats such as HTML and JSON.

Almost 4 times faster4 than Python-Markdown in pure Python environment, almost 5 times faster with Cython's help.

Markdown resources

Markdown does not have an extensive set of strict rules like some othertext formats so you should be able to read up on the basics with thesearticles then write a few practice documents to be comfortable with it.The following resources are really helpful when you are getting startedor need a quick reference on a less commonly-used feature such as tablesor block quotes.

Python Markdown Formatting Example

  • Say yes to Markdown, no to MS Wordprovides a really awesome overview of why Markdown is a more usable fileformat than Microsoft Word and similar proprietary file types. The articlealso has a good list of useful Markdown-related tools such as aMarkdown-to-PDF converter(a NodeJS package but easy enough to use with a basic developmentenvironment).

  • Markdown syntaxis the defacto standard and wonderful reading for both initial learningand random reference.

  • Markdown cheatsheetis a quick reference that is a shortened version of the above Markdownsyntax page.

  • Markdown parsers in Pythonreviews many of the most common Python Markdown parser implementationsto give insight into the advantages and disadvantages of each one.

  • reStructuredText vs Markdown for documentationbrings up some really good points about the downsides to Markdown'ssimplicity. First, a lot of documentation needs more complex output thatis not possible with vanilla Markdown so you need to drop into plain oldHTML, which defeats the purpose of using a markup language. Second, someof the syntax around inserting blank lines by adding spaces at the endof lines is confusing if someone is using atext editor or development environment thatis not configured to show blank spaces. Worse yet, if your editor is set toremove blank spaces at the end of lines, which is fairly common amongdevelopers, then you can mistakenly break the formatting intended bythe original author. Overall this is a good piece to read for a balancedview of Markdown and the reasons it provides are one reason why I useboth Markdown and reStructuredText depending on the project.

  • The Python Package Index (PyPI)supports Markdown as of 2018although there are still some tweaks being made to the flavors that can beused such as GitHub-flavored Markdown.

  • PowerShell and Markdownshows how to work with Markdown in PowerShellincluding customizing colors and listing some quirks you may need to getaround.

  • reStructuredText vs. Markdown for technical documentationcompares Markdown and reStructuredText specifically for documentingsoftware and explains where each one has advantages.

  • Reach for Markdown, not LaTeXexamines the virtues of using straight Markdown along with tools suchas pandoc to convert from one file format toanother, including how to use Markdown for presentations and not justregular documentation.

  • Comcast box auto hd tune. Markdown page is a JavaScriptfile that makes it easy to render plain old Markdown as a webpage.

Formatting

What else do you want to learn?

I want to learn how to code a Python web application using a framework.

I've built a Python web app, now how do I deploy it?