README.md

Welcome to SnakeMD

SnakeMD is your ticket to generating Markdown in Python. To prove it to you, we've generated this entire README using SnakeMD. See readme.py for how it was done. To get started, download and install SnakeMD:

pip install snakemd

In the remainder of this document, we'll show you all of the things this library can do. For more information, check out the official documentation here.

Table of Contents

Below you'll find the table of contents, but these can also be generated programatically for every Markdown document. As of v0.8.0, you can also specify which types of headings are included in the table of contents.

def _table_of_contents(doc: Document):
    doc.add_table_of_contents(range(2, 4))

1. Table of Contents
2. Paragraphs
3. Links
4. Images
5. Lists
   1. Ordered List
   2. Unordered List
   3. Checklist
   4. Nested List
6. Tables
7. Code Blocks
8. Quotes
9. Horizontal Rule

Paragraphs

Paragraphs are the most basic feature of any Markdown file. As a result, they are very easy to create using SnakeMD.

SnakeMD Source

def _paragraph(doc: Document):
    doc.add_paragraph("I think. Therefore, I am.")

Markdown Source

I think. Therefore, I am.

Rendered Result

I think. Therefore, I am.

Links

Links are targets to files or web pages and can be embedded in a Paragraph in a variety of ways. As of v0.2.0, we're able to add links to existing paragraphs using the insert_link() method. Even better, in v0.4.0, we can chain these insert_link() calls.

SnakeMD Source

def _insert_link(doc: Document):
    doc.add_paragraph("Learn to program with The Renegade Coder (@RenegadeCoder94).") \
        .insert_link("The Renegade Coder", "https://therenegadecoder.com") \
        .insert_link("@RenegadeCoder94", "https://twitter.com/RenegadeCoder94")

Markdown Source

Learn to program with [The Renegade Coder](https://therenegadecoder.com) ([@RenegadeCoder94](https://twitter.com/RenegadeCoder94)).

Rendered Result

Learn to program with The Renegade Coder (@RenegadeCoder94).

Images

Images can be added by embedding InlineText in a Paragraph.

SnakeMD Source

def _image(doc: Document):
    logo = "https://therenegadecoder.com/wp-content/uploads/2020/05/header-logo-without-tag-300x75.png"
    doc.add_element(Paragraph([InlineText("Logo", url=logo, image=True)]))

Markdown Source

![Logo](https://therenegadecoder.com/wp-content/uploads/2020/05/header-logo-without-tag-300x75.png)

Rendered Result

Lists

SnakeMD can make a variety of Markdown lists. The three main types of lists are ordered, unordered, and checked.

Ordered List

Ordered lists are lists in which the order of the items matters. As a result, we number them.

SnakeMD Source

def _ordered_list(doc: Document):
    doc.add_ordered_list(["Deku", "Bakugo", "Uraraka", "Tsuyu"])

Markdown Source

1. Deku
2. Bakugo
3. Uraraka
4. Tsuyu

Rendered Result

1. Deku
2. Bakugo
3. Uraraka
4. Tsuyu

Unordered List

Unordered lists are lists in which the order of the items does not matter. As a result, we bullet them.

SnakeMD Source

def _unordered_list(doc: Document):
    doc.add_unordered_list(["Crosby", "Malkin", "Lemieux"])

Markdown Source

- Crosby
- Malkin
- Lemieux

Rendered Result

• Crosby
• Malkin
• Lemieux

Checklist

Checklists are lists in which the items themselves can be checked on and off. This feature is new as of v0.10.0.

SnakeMD Source

def _checklist(doc: Document):
    doc.add_checklist(
        [
            "Pass the puck",
            "Shoot the puck",
            "Score a goal"
        ]
    )

Markdown Source

- [ ] Pass the puck
- [ ] Shoot the puck
- [ ] Score a goal

Rendered Result

• Pass the puck
• Shoot the puck
• Score a goal

Nested List

Nested lists are complex lists that contain lists. Currently, SnakeMD does not support any convenience methods to generate nested lists, but they can be created manually using the MDList object. As of v0.4.0, you can forego the InlineText elements if you don't need them.

SnakeMD Source

def _nested_list(doc: Document):
    doc.add_element(
        MDList([
            "Apples",
            InlineText("Onions"),
            MDList([
                "Sweet",
                "Red"
            ]),
            Paragraph(["This is the end of the list!"])
        ])
    )

Markdown Source

- Apples
- Onions
  - Sweet
  - Red
- This is the end of the list!

Rendered Result

• Apples
• Onions
  • Sweet
  • Red
• This is the end of the list!

Tables

Tables are sets of rows and columns which can display text in a grid. To style any of the contents of a table, consider using Paragraph or InlineText. As of v0.4.0, you can also align the columns of the table using the Table.Align enum.

SnakeMD Source

def _table(doc: Document):
    doc.add_table(
        ["Height (cm)", "Weight (kg)", "Age (y)"],
        [
            ['150', '70', '21'],
            ['164', '75', '19'],
            ['181', '87', '40']
        ],
        [Table.Align.LEFT, Table.Align.CENTER, Table.Align.RIGHT],
        0
    )

Markdown Source

| Height (cm) | Weight (kg) | Age (y) |
| :---------- | :---------: | ------: |
| 150         | 70          | 21      |
| 164         | 75          | 19      |
| 181         | 87          | 40      |

Rendered Result

Height (cm)	Weight (kg)	Age (y)
150	70	21
164	75	19
181	87	40

Code Blocks

Code blocks are a form of structured text for sharing code snippets with syntax highlighting.

SnakeMD Source

def _code(doc: Document):
    doc.add_code("x = 5", lang="py")

Markdown Source

```py
x = 5
```

Rendered Result

x = 5

Quotes

Quotes are blocks of text that represent quotes from people.

SnakeMD Source

def _quote(doc: Document):
    doc.add_quote("How Now Brown Cow")

Markdown Source

> How Now Brown Cow

Rendered Result

How Now Brown Cow

Horizontal Rule

Horizontal Rules are visible dividers in a document.

SnakeMD Source

def _horizontal_rule(doc: Document):
    doc.add_horizontal_rule()

Markdown Source

---

Rendered Result

---