@aurodesignsystem-dev/auro-cli 0.0.0-pr333.6 → 0.0.0-pr333.8

package/README.md

@@ -101,7 +101,12 @@ Generates API documentation from the Custom Elements Manifest.
 - a file it includes with `FILE` or `CODE` is missing, including nested includes;
 - a `{{ … }}` placeholder is left in its prose (code is ignored). This includes a misspelled template variable, such as `{{ nmae }}`.
 
-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 }}`.
+Code snippets (fenced blocks, `<pre>` and `<code>` elements, inline code and `CODE` includes) keep every `{{ … }}` expression except template variables and helpers, so Vue, Angular and Handlebars examples come through unchanged, including Handlebars blocks, comments, partials and triple-stash (`{{#each}}`, `{{!-- --}}`, `{{> header}}`, `{{{ raw }}}`). Two kinds of snippet expression are still filled in:
+
+- a template variable on its own: `{{ name }}`, `{{ Name }}`, `{{ namespace }}`, `{{ Namespace }}`, `{{ Version }}`, `{{ dtVersion }}`, `{{ wcssVersion }}`, `{{ monorepoName }}`;
+- a template helper whose arguments are template variables or quoted strings: `{{ capitalize name }}`, `{{ withAuroNamespace "button" }}`, `{{ packageName }}`.
+
+Anything else, such as `{{ name.length }}` or `{{ name | uppercase }}`, is kept as written. To keep a template variable literal, write it as `\{{ name }}`.
 
 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.