Skip to content

Commit c6767a5

Browse files
committed
docs: 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.
1 parent d439eea commit c6767a5

File tree

1 file changed

+100
-0
lines changed

1 file changed

+100
-0
lines changed
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
<!--
2+
The README.md file is a compiled document. No edits should be made directly to this file.
3+
4+
README.md is created by running `npm run build:docs`.
5+
6+
This file is generated based on a template fetched from
7+
`https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README_updated_paths.md`
8+
and copied to `./componentDocs/README.md` each time the the docs are compiled.
9+
10+
The following sections are editable by making changes to the following files:
11+
12+
| SECTION | DESCRIPTION | FILE LOCATION |
13+
|------------------------|---------------------------------------------------|-------------------------------------|
14+
| Description | Description of the component | `./docs/partials/description.md` |
15+
| Use Cases | Examples for when to use this component | `./docs/partials/useCases.md` |
16+
| Additional Information | For use to add any component specific information | `./docs/partials/readmeAddlInfo.md` |
17+
| Component Example Code | HTML sample code of the components use | `./apiExamples/basic.html` |
18+
-->
19+
20+
# {{ capitalize name }}
21+
22+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
23+
<!-- AURO-GENERATED-CONTENT:END -->
24+
25+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) -->
26+
<!-- AURO-GENERATED-CONTENT:END -->
27+
28+
## UI development browser support
29+
30+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/browserSupport.md) -->
31+
<!-- AURO-GENERATED-CONTENT:END -->
32+
33+
## Install
34+
35+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentInstall_esm.md) -->
36+
<!-- AURO-GENERATED-CONTENT:END -->
37+
38+
### Design Token CSS Custom Property dependency
39+
40+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/designTokens.md) -->
41+
<!-- AURO-GENERATED-CONTENT:END -->
42+
43+
### Define dependency in project component
44+
45+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImportDescription.md) -->
46+
<!-- AURO-GENERATED-CONTENT:END -->
47+
48+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImport.md) -->
49+
<!-- AURO-GENERATED-CONTENT:END -->
50+
51+
**Reference component in HTML**
52+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
53+
<!-- AURO-GENERATED-CONTENT:END -->
54+
55+
## Install bundled assets from CDN
56+
57+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleInstallDescription.md) -->
58+
<!-- AURO-GENERATED-CONTENT:END -->
59+
60+
### Bundle example code
61+
62+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleUseModBrowsers.md) -->
63+
<!-- AURO-GENERATED-CONTENT:END -->
64+
65+
## {{ withAuroNamespace name }} use cases
66+
67+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
68+
<!-- AURO-GENERATED-CONTENT:END -->
69+
70+
## API Code Examples
71+
72+
### Default {{ withAuroNamespace name }}
73+
74+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
75+
<!-- AURO-GENERATED-CONTENT:END -->
76+
77+
## Development
78+
79+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/developmentDescription.md) -->
80+
<!-- AURO-GENERATED-CONTENT:END -->
81+
82+
### Start development environment
83+
84+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/localhost.md) -->
85+
<!-- AURO-GENERATED-CONTENT:END -->
86+
87+
### API generation
88+
89+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/api.md) -->
90+
<!-- AURO-GENERATED-CONTENT:END -->
91+
92+
### Testing
93+
94+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/testing.md) -->
95+
<!-- AURO-GENERATED-CONTENT:END -->
96+
97+
### Bundled assets
98+
99+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/bundles.md) -->
100+
<!-- AURO-GENERATED-CONTENT:END -->

0 commit comments

Comments
 (0)