Code Monkey home page Code Monkey logo

gluegun's Introduction

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.