twitter/cli-guide.js

Name: cli-guide.js

Owner: Twitter, Inc.

Description: CLI Guide JQuery Plugin

Created: 2015-05-14 08:30:22.0

Updated: 2017-11-08 01:27:21.0

Pushed: 2017-01-03 04:04:07.0

Homepage: https://twitter.github.io/cli-guide.js/

Size: 9356

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

CLI Guide jQuery Plugin v0.1.4

A Javascript library for creating interactive command line tutorials that run in your web browser.

Dependencies

• jQuery
• Prism

Demos

• Apache Aurora
• CLI Guide

Documentation

Example

  $('#stepsdiv').cli_guide({
    nameOfTheProject: 'Apache Aurora',
    stepsFile: 'templates/apache_aurora.json',
    skipsteps: '1,2',
    commandStepsFile: 'templates/apache_aurora_commands.json',
    commandValidation: 'templates/apache_aurora_commands_validations.json',
    preloadfile: 'templates/apache_aurora_files.json'
  });

Build

• Install node modules

  $ npm install

• For generate files

  $ npm start

• For development

  $ npm run dev

Author

• Willy Aguirre https://twitter.com/willrre

License

Copyright 2016 Twitter, Inc.

Licensed under the MIT License