Skip to content

Commit 8c4011d

Browse files
zeroedinbennypowers
authored andcommitted
fix(create-element): add missing docs on create
1 parent 24dd236 commit 8c4011d

File tree

3 files changed

+25
-0
lines changed

3 files changed

+25
-0
lines changed

.changeset/lazy-crabs-pay.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@patternfly/create-element": patch
3+
---
4+
5+
Adds docs folder and index.md file on initial creation of a new element

tools/create-element/generator/element.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ enum FileKey {
3535
demo = 'demo',
3636
demoCss = 'demoCss',
3737
demoScript = 'demoScript',
38+
docs = 'docs',
3839
package = 'package',
3940
readme = 'readme',
4041
style = 'style',
@@ -70,6 +71,7 @@ const TEMPLATE_FILE_PATHS: Record<FileKey, string> = {
7071
demo: 'demo/element.html',
7172
demoCss: 'demo/element.css',
7273
demoScript: 'demo/element.js',
74+
docs: 'docs/index.md',
7375
package: 'package.json',
7476
readme: 'README.md',
7577
style: 'element.scss',
@@ -86,6 +88,7 @@ const getFilePathsRelativeToPackageDir =
8688
demo: `demo/${options.tagName}.html`,
8789
demoCss: `demo/demo.css`,
8890
demoScript: `demo/${options.tagName}.js`,
91+
docs: `docs/index.md`,
8992
package: 'package.json',
9093
readme: 'README.md',
9194
style: `${options.tagName}.scss`,
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{% renderOverview %}
2+
<<%= tagName %>></<%= tagName %>>
3+
{% endrenderOverview %}
4+
5+
{% band header="Usage" %}{% endband %}
6+
7+
{% renderSlots %}{% endrenderSlots %}
8+
9+
{% renderAttributes %}{% endrenderAttributes %}
10+
11+
{% renderMethods %}{% endrenderMethods %}
12+
13+
{% renderEvents %}{% endrenderEvents %}
14+
15+
{% renderCssCustomProperties %}{% endrenderCssCustomProperties %}
16+
17+
{% renderCssParts %}{% endrenderCssParts %}

0 commit comments

Comments
 (0)