@@ -4,4 +4,58 @@ title: Coderoad-CLI
44id : cli
55---
66
7- coming soon
7+ ##### Commands
8+ - create [ name]
9+ - build [ tutorial.md]
10+ - publish [ version] _ currently instructions only_
11+ - tutorials _ coming soon_
12+ - search [ query] _ currently instructions only_
13+ - docs
14+ - help
15+
16+ ##### Create
17+
18+ "create" gets you started building your tutorial.
19+
20+ ```
21+ > coderoad create $my-tutorial-name$
22+ ```
23+
24+ "create" generates:
25+
26+ * a ` package.json ` configuration with the following settings:
27+
28+ ```
29+ {
30+ "name": "coderoad-$TUTORIAL-NAME$",
31+ "main": "coderoad.json",
32+ "keywords": ["coderoad", "tutorial"],
33+ "dependencies": {
34+ "mocha-coderoad": "^0.3.1"
35+ },
36+ "coderoad": {
37+ "testDir": "test",
38+ "testSuffix": ".spec.js",
39+ "testRunner": "mocha-coderoad"
40+ }
41+ ```
42+
43+ * an example ` tutorial.md ` file & tutorial directory
44+ * an example ` test ` directory with a few example tests
45+
46+ Feel free to fill out the "author" or "authors" field, and add any additional
47+ project related keywords.
48+
49+ ##### Build
50+
51+ "build" compiles your markdown tutorial into a data file called ` coderoad.json ` .
52+
53+ "build" defaults to ` tutorial/tutorial.md ` . Optionally specify the path to your tutorial markdown file.
54+
55+ ```
56+ > coderoad build
57+ > coderoad build $path/to/tutorial.md$
58+ ```
59+
60+ "build" also generates a ` README.md ` with an outline of your chapters & pages
61+ as well as an explanation of how to setup your tutorial.
0 commit comments