Skip to main content

A small library for writing markdown with a tree structure of python objects that you can transform into a markdown snippet(string).

Project description

#Markdown Tags
-----

A small library for writing markdown with a tree structure of python objects that you can transform into a
markdown snippet(string).

I started it by extracting some code I wrote for a reddit bot.

It was partially inspired by looking at the ScalaTags examples(although not using it).

ex. 2 Paragraphs, 1 in Italic the other in Bold.

import markdown_tags as m

tags = m.MD(m.Paragraph(m.Italic("Italian")), m.Paragraph(m.Bold("Boring, Portland")))
markdown_str = tags.tags_to_markdown(recover=False, format_md=m.MarkdownFormats.reddit)

*returns a markdown string that will render as:*

*Italian*

**Boring, Portland**'

ex. of a nested list or a list with multi paragraph items.

import markdown_tags as m


tags = m.MD(m.UnorderedList.with_title("Maslow's hierarchy of needs partial outline",
m.OrderedList(
m.UnorderedList.with_title("Physiological needs",
"Air",
"Water"),
m.UnorderedList.with_title("Safety needs",
"Personal security",
"Financial security",
"Health and well-being",
"Safety net against accidents/illness " +
"and their adverse impacts"),
"Love and belonging",
"Esteem",
"Self-actualization"),
"Research",
"Criticism"))

*returns a markdown string that will render as:*



Maslow's hierarchy of needs partial outline

+ Needs

1. Physiological needs

+ Air

+ Water

2. Safety needs

+ Personal security

+ Financial security

+ Health and well-being

+ Safety net against accidents/illness and their adverse impacts

3. Love and belonging

4. Esteem

5. Self-actualization

+ Research

+ Criticism


*note that the discount markdown implementation used by reddit seems to translate this to html fine but it shows up
a little strange with outer unordered list w/ the same indentation as inner ordered list on reddit.*

Tested with the discount markdown implementation used by reddit.
I might look into testing with other markdown implementations later.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

markdown_tags-0.2.1.tar.gz (5.6 kB view details)

Uploaded Source

File details

Details for the file markdown_tags-0.2.1.tar.gz.

File metadata

  • Download URL: markdown_tags-0.2.1.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for markdown_tags-0.2.1.tar.gz
Algorithm Hash digest
SHA256 6a51a3b29390d8a454926da7e3a4a6b86d88399a8ce058918436907a863e5aec
MD5 0fc68c6d607c27bfe14966804a16b5d1
BLAKE2b-256 cef45e549e21360e70e37bddd421fd1010ae094dd112f4373dfd1fbb66eeee26

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page