@aurodesignsystem-dev/auro-cli 0.0.0-pr331.0 → 0.0.0-pr333.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -0
- package/dist/auro-cli.js +71 -69
- package/dist/auro-cli.js.map +3 -3
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -94,6 +94,20 @@ Generates API documentation from the Custom Elements Manifest.
|
|
|
94
94
|
- `-p, --port <number>`: server port.
|
|
95
95
|
- `-o, --open`: open the browser once the server is up.
|
|
96
96
|
|
|
97
|
+
#### Docs generation
|
|
98
|
+
|
|
99
|
+
`auro build` and `auro docs` generate `README.md` and the `demo/*.md` pages from `docs/partials/` and `docs/pages/`. If any docs file fails, the rest are still generated. Then the command exits non-zero and lists every failed file. A docs file fails when:
|
|
100
|
+
|
|
101
|
+
- a file it includes with `FILE` or `CODE` is missing, including nested includes;
|
|
102
|
+
- a `{{ … }}` placeholder is left in its prose (code is ignored).
|
|
103
|
+
|
|
104
|
+
In watch mode, a docs failure is reported but doesn't stop the watcher or the dev server. `auro docs --watch` rebuilds when you fix the file. `auro dev` and `auro build --watch` regenerate docs on the next source change.
|
|
105
|
+
|
|
106
|
+
**Upgrading a component created before auro-cli v4:** the v4 README template includes these files, so create them, even empty, or the build fails:
|
|
107
|
+
|
|
108
|
+
- `docs/partials/customRegistration.md`
|
|
109
|
+
- `apiExamples/custom.html`
|
|
110
|
+
|
|
97
111
|
#### `auro test`
|
|
98
112
|
|
|
99
113
|
Runs the web test runner against the component library.
|