Determines which markup library to use to render a content file (e.g. README) on GitHub
MIT License
This library is the first step of a journey that every markup file in a repository goes on before it is rendered on GitHub.com:
github-markup
selects an underlying library to convert the raw markup to HTML. See the list of supported markup formats below.script
tags, inline-styles, and class
or id
attributes.Please note that only the first step is covered by this gem — the rest happens on GitHub.com. In particular, markup
itself does no sanitization of the resulting HTML, as it expects that to be covered by whatever pipeline is consuming the HTML.
Please see our contributing guidelines before reporting an issue.
The following markups are supported. The dependencies listed are required if
you wish to run the library. You can also run script/bootstrap
to fetch them all.
gem install commonmarker
(https://github.com/gjtorikian/commonmarker)gem install RedCloth
(https://github.com/jgarber/redcloth)gem install rdoc -v 3.6.1
gem install org-ruby
(https://github.com/wallyqs/org-ruby)gem install creole
(https://github.com/larsch/creole)gem install wikicloth
(https://github.com/nricciar/wikicloth)pip install docutils
gem install asciidoctor
(http://asciidoctor.org)Pod::Simple::XHTML
gem install github-markup
or
bundle install
from this directory.
Basic form:
require 'github/markup'
GitHub::Markup.render('README.markdown', "* One\n* Two")
More realistic form:
require 'github/markup'
GitHub::Markup.render(file, File.read(file))
And a convenience form:
require 'github/markup'
GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, "* One\n* Two")
python3 -m venv .venv
source .venv/bin/activate
cd script
./bootstrap
See Contributing.