A javascript library for creating interactive command line tutorials that run in your web browser
$('#stepsdiv').cliguide(
{
nameOfTheProject: 'Apache Aurora',
stepsFile: 'templates/apache_aurora.json',
initStep: 1
}).cli(
{
commandStepsFile: 'templates/apache_aurora_commands.json',
preloadfile: 'templates/apache_aurora_files.json'
}, function(){
});
| Property | Description |
|---|---|
| welcomeMessage | Message of welcome to the tutorial |
| nameOfTheProject | name of the project |
| heightTerminal | by default is the height of the window |
| stepsFile | a .json file |
| commandStepsFile | a .json file |
| preloadfile | a .json file |
[
{
"step": "0",
"content": {
"title": "Setup: Install Aurora 0",
"content": [
" You use the Aurora client and web UI to interact with Aurora jobs. ",
" To install it locally, see vagrant.md. The remainder of this Tutorial ",
" assumes you are running Aurora using Vagrant. Unless otherwise stated, ",
" all commands are to be run from the root of the aurora repository clone."
],
"tips": "You can run $ <i>aurora</i> for see all commands"
}
}
]
[
{
"command":"hello world!",
"result": "test...."
}
]
[
{
"name":"test.txt",
"content": "Hello World!"
},
{
"name":"hello.py",
"content": "print(\"Hello World!\")"
}
]
$ npm install
$ gulp
Copyright 2015 Twitter, Inc.
Licensed under the MIT License