A small Swift library to generate Markdown documents.
Features
- ✅ Easily generate Markdown from structured data
- ✅ Extendible: make your classes and structs conform to
MarkdownConvertible - ✅ Swift Package Manager compatible (Swift 4.0+)
- ✅ Linux compatible 🐧
Types conforming to the MarkdownConvertible protocol can be rendered as a
markdown string, by implementing the .markdown computed property.
Out of the box, MarkdownGenerator provides the following Markdown elements:
- Unordered lists
- Ordered lists
- Tables
- Block-quotes
- Code Blocks
- Collapsible Blocks
- Images
- Links
- Headings
Please take a look at the following examples, or read the reference documentation.
List can be nested to any levels and contain single or multi-line items. Lists can be ordered, unordered, or mixed.
let list = MarkdownList(items: ["🍏", "🍌", "🍊", "🍇"])
print(list.markdown)Generates the following output:
- 🍏
- 🍌
- 🍊
- 🍇
Which renders as:
- 🍏
- 🍌
- 🍊
- 🍇
While Markdown didn't have support for tables originally, most modern Markdown readers (including GitHub) properly render tables nowadays.
let data: [[String]] = [
["🍏", "Apple", "Fruits"],
["🍊", "Orange", "Fruits"],
["🥖", "Bread", "Bakery"],
]
let table = MarkdownTable(headers: ["", "Name", "Department"], data: data)
print(table.markdown)Generates the following output:
| | Name | Department |
| -- | ------ | ---------- |
| 🍏 | Apple | Fruits |
| 🍊 | Orange | Fruits |
| 🥖 | Bread | Bakery |
Which renders as:
| Name | Department | |
|---|---|---|
| 🍏 | Apple | Fruits |
| 🍊 | Orange | Fruits |
| 🥖 | Bread | Bakery |
Pretty tables 🎉
Any MarkdownConvertible content (including String) can be easily .blockquoted.
let input = """
## This is a header.
1. This is the first list item.
2. This is the second list item.
Here's some example code:
return shell_exec("echo $input | $markdown_script");
> This is a quote.
"""
print(input.blockquoted.markdown)Generates the following output:
> ## This is a header.
>
> 1. This is the first list item.
> 2. This is the second list item.
>
> Here's some example code:
>
> return shell_exec("echo $input | $markdown_script");
>
> > This is a quote.
Which renders as:
- This is the first list item.
- This is the second list item.
Here's some example code:
return shell_exec("echo $input | $markdown_script");This is a quote.
Collapsible blocks look great on GitHub and other Markdown viewers. Great way to provide detailed content without cluttering the output.
let details: [MarkdownConvertible] = [
MarkdownHeader(title: "Title"),
MarkdownList(items: ["🐶", "🐱", "🦊"]),
MarkdownTable(headers: ["Name", "Count"], data: [["Dog", "1"], ["Cat", "2"]]),
MarkdownCodeBlock(code: "let foo = Bar()", style: .backticks(language: "swift"))
]
print(MarkdownCollapsibleSection(summary: "This is cool stuff", details: details).markdown)Generates the following output:
<details><summary>This is cool stuff</summary>
# Title
- 🐶
- 🐱
- 🦊
| Name | Count |
| ---- | ----- |
| Dog | 1 |
| Cat | 2 |
```swift
let foo = Bar()
```
</details>
Which renders as (click to expand):
Follow and/or contact me on Twitter at @eneko.
If you find an issue, just open a ticket on it. Pull requests are warmly welcome as well.
MarkdownGenerator is licensed under the Apache 2.0 license. See LICENSE for more info.