-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add _updated_paths README variant
This variant of the README is intended to be used in components that depend on the new version of auro-library.
- Loading branch information
1 parent
5a5c184
commit f3ac678
Showing
1 changed file
with
100 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| <!-- | ||
| The README.md file is a compiled document. No edits should be made directly to this file. | ||
| README.md is created by running `npm run build:docs`. | ||
| This file is generated based on a template fetched from | ||
| `https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README_updated_paths.md` | ||
| and copied to `./componentDocs/README.md` each time the the docs are compiled. | ||
| The following sections are editable by making changes to the following files: | ||
| | SECTION | DESCRIPTION | FILE LOCATION | | ||
| |------------------------|---------------------------------------------------|-------------------------------------| | ||
| | Description | Description of the component | `./docs/partials/description.md` | | ||
| | Use Cases | Examples for when to use this component | `./docs/partials/useCases.md` | | ||
| | Additional Information | For use to add any component specific information | `./docs/partials/readmeAddlInfo.md` | | ||
| | Component Example Code | HTML sample code of the components use | `./apiExamples/basic.html` | | ||
| --> | ||
|
|
||
| # {{ capitalize name }} | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## UI development browser support | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/browserSupport.md) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## Install | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentInstall_esm.md) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ### Design Token CSS Custom Property dependency | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/designTokens.md) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ### Define dependency in project component | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImportDescription.md) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImport.md) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| **Reference component in HTML** | ||
| <!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## Install bundled assets from CDN | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleInstallDescription.md) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ### Bundle example code | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleUseModBrowsers.md) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## {{ withAuroNamespace name }} use cases | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## API Code Examples | ||
|
|
||
| ### Default [namespace]-[name] | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ## Development | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/developmentDescription.md) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ### Start development environment | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/localhost.md) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ### API generation | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/api.md) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ### Testing | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/testing.md) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> | ||
|
|
||
| ### Bundled assets | ||
|
|
||
| <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/bundles.md) --> | ||
| <!-- AURO-GENERATED-CONTENT:END --> |