Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eneko/markdowngenerator
Swift library to programmatically generate Markdown output and files
https://github.com/eneko/markdowngenerator
generator markdown swift swift-framework swift-package swift-package-manager
Last synced: 5 days ago
JSON representation
Swift library to programmatically generate Markdown output and files
- Host: GitHub
- URL: https://github.com/eneko/markdowngenerator
- Owner: eneko
- License: apache-2.0
- Created: 2017-10-09T06:42:14.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2021-02-07T04:06:44.000Z (almost 4 years ago)
- Last Synced: 2025-01-10T19:10:04.989Z (13 days ago)
- Topics: generator, markdown, swift, swift-framework, swift-package, swift-package-manager
- Language: Swift
- Size: 110 KB
- Stars: 98
- Watchers: 4
- Forks: 62
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# MarkdownGenerator
[](https://travis-ci.com/eneko/MarkdownGenerator)
[](https://codecov.io/gh/eneko/MarkdownGenerator)
[](https://swift.org/package-manager)
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 🐧
## MarkdownConvertible
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](/docs).
### Lists
List can be nested to any levels and contain single or multi-line items. Lists can be ordered, unordered, or mixed.
```swift
let list = MarkdownList(items: ["🍏", "🍌", "🍊", "🍇"])
print(list.markdown)
```
Generates the following output:
- 🍏
- 🍌
- 🍊
- 🍇
Which renders as:
- 🍏
- 🍌
- 🍊
- 🍇
### Tables
While Markdown didn't have support for tables originally, most modern Markdown readers (including GitHub) properly render tables nowadays.
```swift
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 🎉
### Blockquotes
Any `MarkdownConvertible` content (including `String`) can be easily `.blockquoted`.
```swift
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 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.
### Collapsible Blocks
Collapsible blocks look great on GitHub and other Markdown viewers. Great way to provide detailed content without cluttering the output.
```swift
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:
This is cool stuff
# Title
- 🐶
- 🐱
- 🦊
| Name | Count |
| ---- | ----- |
| Dog | 1 |
| Cat | 2 |
```swift
let foo = Bar()
```
Which renders as (click to expand):
This is cool stuff
# Title
- 🐶
- 🐱
- 🦊
| Name | Count |
| ---- | ----- |
| Dog | 1 |
| Cat | 2 |
```swift
let foo = Bar()
```
## Contact
Follow and/or contact me on Twitter at [@eneko](https://www.twitter.com/eneko).
## Contributions
If you find an issue, just [open a ticket](https://github.com/eneko/MarkdownGenerator/issues/new)
on it. Pull requests are warmly welcome as well.
## License
MarkdownGenerator is licensed under the Apache 2.0 license. See [LICENSE](/LICENSE) for more info.