Markdowner generates Roblox guis to display markdown, supporting:
- Paragraphs
- Bullet point lists
- Numbered lists
- Nested lists
- Code blocks
- Syntax highlighting Lua code
- Inline code
- Horizontal rule (line)
- Blockquotes
- Images
- Preserving original links while showing Roblox asset images only when viewed in Roblox i.e. markdown with images that can be viewed both in- and out-of Roblox
- Doing a relayout of the markdown gui using the same data and some of the same gui objects.
Markdowner uses the following open-source modules:
Markdown is turned into html which is then turned into Roblox gui. This is not optimal. This project was hacked together with the intention of developing a documentation plugin, but I never got around to it! This would be a great inclusion to a documentation viewer plugin!
@ChipioIndustries suggested I open source this at RDC, so here it is! I included some minimal documentation for now – I’m still at RDC and don’t have time to write full docs.
Edit: At least a UIListLayout is required in your gui for Markdowner to display properly. Initially, this was not noted in the docs and no default UIListLayout was created. The module has been updated with relevant documentation and with default UI layouts.
Here is Markdowner rendering markdown.lua's README (+ an added list for example purposes):
MarkdownerPublic.rbxl (57.9 KB)
Source:
# markdown.lua
[](https://travis-ci.org/mpeterv/markdown)
[](https://coveralls.io/r/mpeterv/markdown?branch=master)
List
* Lista
* Listb
1. List2a
2. List2b
1. List3a
2. List3b
This is an implementation of the popular text markup language Markdown in pure Lua.
Markdown can convert documents written in a simple and easy to read text format
to well-formatted HTML. For a more thorough description of Markdown and the Markdown
syntax, see http://daringfireball.net/projects/markdown/.
The original Markdown source is written in Perl and makes heavy use of advanced
regular expression techniques (such as negative look-ahead, etc) which are not available
in Lua's simple regex engine. Therefore this Lua port has been rewritten from the ground
up. It is probably not completely bug free. If you notice any bugs, please report them using
GitHub issues. A unit test that exposes the error is helpful.
`markdown.lua` has been written by Niklas Frykholm ([original](http://www.frykholm.se/files/markdown.lua)).
This version has been updated to run under Lua 5.2 and Lua 5.3 in addition to Lua 5.1.
## Usage
```lua
local markdown = require "markdown"
markdown(source)
```
`markdown` module returns a single function which applies the Markdown transformation to the
specified string. For compatibility it is also set as a global.
`markdown.lua` can also be used directly from the command line:
```
lua markdown.lua test.md
```
Creates a file `test.html` with the converted content of `test.md`. Run:
```
lua markdown.lua -h
```
For a description of the command-line options.
## Installation
Simply copy `markdown.lua` into your directory for Lua libraries. Alternatively,
use [LuaRocks](https://luarocks.org/) and run `[sudo] luarocks install markdown`.
## Miscellaneous
`markdown.lua` uses the same license as Lua, the MIT license.
An alternative Markdown implementation is [lua-discount](http://asbradbury.org/projects/lua-discount/).
It is faster than `markdown.lua`, at the cost of being written in C.
[roblox https://travis-ci.org/mpeterv/markdown.png?branch=master]: rbxassetid://2651257779 "=90x20"
[roblox https://coveralls.io/repos/mpeterv/markdown/badge.svg?branch=master]: rbxassetid://2651258000 "=99x20"
