/gluegun

Glues Github markdown docs to present a beautiful documentation site.

Primary LanguageRubyApache License 2.0Apache-2.0

Gluegun

Gluegun glues markdown files to generate a beautiful documenation site.

Installation

Add this line to your application's Gemfile:

gem 'gluegun'

And then execute:

$ bundle

Or install it yourself as:

$ gem install gluegun

Or in your script:

require `gluegun`

Usage

    NAME:
      gluegun - Glues github markdown files to a documentation site.

    USAGE:
      gluegun COMMAND [ARGUMENTS...]

    COMMANDS:
      generate Generate new docs site with an URL or file path.

Example

    gluegun generate https://github.com/gluegun/site_sample_config.yml