Project

gluegun

0.02
Repository is archived
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
Gluegun is glues markdown docs from github and pulls together a beautiful docs site.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.15
~> 10.0
 Project Readme

Gluegun

Gluegun glues markdown files to generate a beautiful documentation site.

Pre-Requisite

A minimum version of ruby2.4 is required.

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

Building Gluegun Gem

Build the gem using the command

gem build gluegun.gemspec

Install the gem

gem install gluegun

Run the gluegun CLI

./gluegun generate ./site.yml