About

Installation

gem install markdown-ui

Usage

markdown-ui index.mdui > index.html

Markdown-UI (Read-Evaluate-Print-Loop) REPL shell

markdown-ui-shell

$ markdown-ui-shell



Hit RETURN three times to parse.

# __Button|A Button__

#

#



<button class="ui button">A Button</button>



#

Credits

Source

Notes/Issues/Bugs

Ongoing support for Semantic-UI elements/modules/components

The Colon (:) character will be parsed when used inside a text, needs post-processing to dislay correctly (for URLs)

A separator in between two spaces is required on block elements to separate elements (see Column example)

Some elements requires custom javascripts (ie toggle button) in order to display and format them properly. You can write in HTML and Javascripts the additional code alongside your Markdown-UI docs to display them properly.

Markdown-UI is a development framework that utilizes the Semantic-UI web framework, to create beautiful, human-friendly HTML and responsive layouts using Markdown Syntax.Markdown-UI is not affiliated with Semantic-UI in any matter.Markdown-UI is readily available as a Ruby gem. The minimum required Ruby version is 2.0.Output is via standard out, which can be piped to create an HTML file. (Under Mac and Linux)You can interactively create Markdown-UI websites using theMarkdown-UI would not be possible without the the Semantic-UI framework, and the Ruby RedCarpet library. A huge thanks and credit goes to the people behind these wonderful framework and libraries.This document is written entirely in Markdown-UI. see: the source files