how to use python markdown

A sample of python-markdown. It isn't GFM, or other markdown, but so what?

Most regular markups needed pandoc, which is not available on cygwin, and is apparently a pain for regular Linux (it needs LaTeX), even with admin privs.

references:

<section header starts with '##' in column 1>

• source: https://python-markdown.github.io
• built-in extensions: https://python-markdown.github.io/extensions/
• 3rd-party extensions: https://github.com/facelessuser/pymdown-extensions
• e.g., magiclink: https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/

<this list starts with '*' in column 1>

and a possible basic cheat-sheet:

• https://www.markdownguide.org/cheat-sheet/

installation

on faa laptop using cygwin (from: https://python-markdown.github.io):

    pip2.7 install markdown         # cygwin - faa laptop
    pip-2.7 install markdown        # webfaction

<lines begin with 8 spaces>

and get the supporing parts from: https://github.com/facelessuser/pymdown-extensions:

    wget https://github.com/facelessuser/pymdown-extensions/archive/master.zip
    ...
    unzip pymdown-extensions-master.zip

    python setup.py install        # cygwin - faa
    python3 setup.py install       # webfaction

running:

from command line:

markdown_py  -x fenced_code -x tables -x pymdownx.magiclink  -x pymdownx.tasklist  how_to_markdown.txt > how.html

<block has '~~~~' before and after>

or makefile:

$ cat makefile

how.html:   how_to_markdown.txt
        markdown_py                              \
                -x fenced_code                   \
                -x tables                        \
                -x pymdownx.magiclink            \
                -x pymdownx.tasklist             \
                how_to_markdown.txt  > how.html

THEN open that output file in web browser ( :-( ), i.e., no pdf or ps.

NOTE: makefile on webfaction is better

samples of markup:

and some text italic and other italic text and some bold text and more bold text

lists:

• one
• two
  • two a
  • two b

first list has starts with '*', second list with '    *'

links

http://ilikecarrots.com

code

indent each line by four spaces and preceeded by a blank line:

for k in range(4):
    helpme()

fenced by "~~~~{.bash}" in front and "~~~~" at end:

    ls -ltr

not sure what the {.bash} did.

A table:

indent by 8 spaces and preceed by blank line:

    $ python -m markdown foo.txt > aaa.html

NOTE: most elements must be preceeded by non-plain text line (headers are ok)

-x options:

• sane_lists : didn't seem to add anything
• tables: ok, but no borders, so not much there
• fenced code: adds '~~~~' as delimeters, and no blank line needed

Task List:

• item 1
  • item A
  • item B more text
    • item a
    • item b
    • item c
  • item C
• item 2
• item 3

html

break

span's only highlight text, div goes width of browser