@aurodesignsystem-dev/auro-cli 0.0.0-pr333.1 → 0.0.0-pr333.3
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 +3 -1
- package/dist/auro-cli.js +77 -77
- package/dist/auro-cli.js.map +3 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -99,7 +99,9 @@ Generates API documentation from the Custom Elements Manifest.
|
|
|
99
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
100
|
|
|
101
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).
|
|
102
|
+
- a `{{ … }}` placeholder is left in its prose (code is ignored). This includes a misspelled template variable, such as `{{ nmae }}`.
|
|
103
|
+
|
|
104
|
+
Code snippets keep `{{ … }}` expressions that aren't template variables, so Vue, Angular and Handlebars examples come through unchanged. A snippet expression that matches a template variable (`name`, `Name`, `namespace`, `Namespace`, `Version`, `dtVersion`, `wcssVersion`, `monorepoName`) is still filled in. To keep one literal, write it as `\{{ name }}`.
|
|
103
105
|
|
|
104
106
|
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
107
|
|