Nexmo Markdown Renderer

This gem facilitates the presentation of markdown documents in a Rails app by applying custom filters for tabs, code snippets, icons, indentation and more. It is used in the Nexmo Developer Platform.

• Installation and Usage
  • In An Application
  • CLI Standlone
• Contributing
• License

To use this gem you must install it in your application's Gemfile:

gem 'nexmo-markdown-renderer'

Then run bundle install to install it.

The gem requires an environment variable to be set of DOCS_BASE_PATH that should point to the top level directory of your markdown content to be rendered. For example:

DOCS_BASE_PATH = '/path/to/markdown`

Once you have installed it, you can use it by instantiating an instance of it by passing in the options you require:

content = Nexmo::Markdown::Renderer.new()

Once you have instantiated an instance, you can then invoke the #call method with the markdown you wish to render. You can either point to a file or pass in the markdown directly:

Passing in the markdown directly:

rendered = content.call( "with markdown" )

Passing in a markdown file:

rendered = content.call("/_documentation/example/example_markdown.md")

To use the markdown renderer with the built-in CLI, you first must install the gem locally:

$ gem install nexmo-markdown-renderer

Once the gem is installed you can use the CLI to generate HTML output for a provided markdown file. To do so, you must specify both a path to the documentation folder and the specific markdown file you wish to render:

$ DOCS_BASE_PATH=path/to/docs bundle exec nexmo-markdown-renderer render _documentation/path/sample.md

The converted HTML output will be displayed in your console.

We ❤️ contributions from everyone! Bug reports, bug fixes and feedback on the gem is always appreciated. Look at the Contributor Guidelines for more information.

This project is under the MIT LICENSE