Command line interface for CodeRoad.
> npm install -g coderoad-cli
- create [name]
- build [tutorial.md]
- publish [version] coming soon
- tutorials coming soon
- search [query] coming soon
- help
"create" gets you started building your tutorial.
> coderoad create $my-tutorial-name$
"create" generates:
- a
package.json
configuration with the following settings:
"name": "coderoad-$my-tutorial-name$",
"main": "coderoad.json",
"keywords": ["coderoad"],
"coderoad": {
"testDir": "test",
"testSuffix": ".spec.js"
}
- an example
tutorial.md
file & tutorial directory - an example
test
directory with a few example tests
Feel free to fill out the "author" or "authors" field, and add any additional project related keywords.
"build" compiles your markdown tutorial into a data file called coderoad.json
.
"build" defaults to tutorial/tutorial.md
. Optionally specify the path to your tutorial markdown file.
> coderoad build
> coderoad build $path/to/tutorial.md$
"build" also generates a README.md
with an outline of your chapters & pages
as well as an explanation of how to setup your tutorial.