0.06
No release in over 3 years
Low commit activity in last 3 years
There's a lot of open issues
Create responsive UI/UX for mobile and web using Markdown Syntax
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

Runtime

~> 1.10, ~> 1.9
~> 1.5, ~> 1.6
~> 3.3
 Project Readme

Join the chat at https://gitter.im/jjuliano/markdown-ui

Code Climate Build Status Test Coverage Gem Version

Markdown UI

Write UI in Markdown Syntax. See http://jjuliano.github.io/markdown-ui/

Installation

Markdown-UI is readily available as a Ruby gem. The minimum required Ruby version is 2.0.

$ gem install markdown-ui

Usage

Output is via standard out, which can be piped to create an HTML file. (Under Mac and Linux)

$ markdown-ui index.mdui > index.html

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

You can interactively create Markdown-UI websites using the markdown-ui-shell.

$ markdown-ui-shell

Hit RETURN three times to parse.
# __Button|A Button__
#
#

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

#

Credits

Markdown-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.

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.

Contributing

  1. Fork it ( https://github.com/jjuliano/markdown-ui/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request