Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(tools)!: docs and demos refactor #2059

Merged
merged 24 commits into from
Jul 24, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
38e6f61
docs: wip generate docs pages
bennypowers Jul 14, 2022
e42b37d
docs: remove core demos
bennypowers Jul 17, 2022
77a6393
refactor(tools)!: do async work in 11ty plugin
bennypowers Jul 17, 2022
cf06540
fix(create-element): simplify element demo templates
bennypowers Jul 18, 2022
23ec545
feat(tools): allow for multiple demos
bennypowers Jul 18, 2022
3e85948
feat(tools): wip generate docs pages
bennypowers Jul 18, 2022
1cbe047
feat(tools): add demos entries to cem
bennypowers Jul 18, 2022
aaedb39
docs: generate multiple demo pages per package
bennypowers Jul 18, 2022
ceacff8
docs: generate core demos
bennypowers Jul 18, 2022
0a384f9
feat(tools): add extraDemos option to cem 11ty plugin
bennypowers Jul 19, 2022
ac65ae9
fix(tools): calculate demos
bennypowers Jul 19, 2022
67670b4
refactor(tools): manifest helpers
bennypowers Jul 19, 2022
b9f7391
fix: updating overview.njk package to print package.name
brianferry Jul 20, 2022
cc91f94
fix(tools): hide elements from demo menu if no demo
bennypowers Jul 21, 2022
a2cb9a4
fix(tools): redirect to lightdom assets
bennypowers Jul 21, 2022
22553b6
docs: refactor demo paginator
bennypowers Jul 21, 2022
17e9c07
feat(tools): link demos to absolute urls
bennypowers Jul 21, 2022
a80b102
fix(tools): multiple demos
bennypowers Jul 21, 2022
f4ad42a
docs: fix demo pages
bennypowers Jul 21, 2022
94520d4
feat(tools): multiple demos in dev server
bennypowers Jul 21, 2022
7f91eaf
Merge remote-tracking branch 'origin/main' into docs/docs-page-refactor
bennypowers Jul 21, 2022
f4da362
Merge branch 'docs/docs-page-refactor' of https://github.com/patternf…
brianferry Jul 21, 2022
1bbe13e
chore: fixing typo, reordering the importmap
brianferry Jul 21, 2022
dfb9061
docs: simplify font-awesome loading
bennypowers Jul 24, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/components/demos.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,16 +75,16 @@
<title>{{ demo.title or (demo.tagName) }} | PatternFly Elements</title>
<link rel="preconnect" href="https://ga.jspm.io">
<link rel="preconnect" href="https://fonts.gstatic.com">
<script type="importmap">{{ importMap | dump | safe }}</script>
{%- for path in preloads -%}
<link rel="modulepreload" href="https://ga.jsmp.io/npm:{{ path }}"/>
<link rel="modulepreload" href="https://ga.jspm.io/npm:{{ path }}"/>
{%- endfor -%}
<link rel="stylesheet" href="/main.css"/>
<link rel="stylesheet" href="/core/styles/pfe.min.css">
<link rel="stylesheet" href="/core/styles/pfe-layouts.min.css">
<link rel="stylesheet" href="/core/styles/red-hat-font.min.css">
<noscript><link href="/core/styles/pfe--noscript.min.css" rel="stylesheet"></noscript>
<script async src="https://ga.jspm.io/npm:es-module-shims@1.5.9/dist/es-module-shims.js"></script>
<script type="importmap">{{ importMap | dump | safe }}</script>
</head>
<body unresolved>{% if demo.filePath %}
{%- include demo.filePath -%}{% endif %}
Expand Down
2 changes: 1 addition & 1 deletion elements/pfe-button/demo/pfe-button.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ for (const button of document.querySelectorAll('pfe-button')) {
}

(async function() {
const PfeIcon = await customElements.whenDefined('pfe-icon');
const PfeIcon = await customElements.get('pfe-icon');
PfeIcon.addIconSet('fa', './', function(name) {
switch (name) {
case 'fa-external-link-square':
Expand Down
2 changes: 1 addition & 1 deletion elements/pfe-button/docs/pfe-button.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
</style>

<script type="module">
const PfeIcon = await customElements.whenDefined('pfe-icon');
const PfeIcon = await customElements.get('pfe-icon');
PfeIcon.addIconSet('fa', './', function(name) {
switch (name) {
case 'fa-external-link-square':
Expand Down
2 changes: 1 addition & 1 deletion tools/pfe-tools/11ty/templates/overview.njk
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<h2 slot="header">Installation</h2>

```shell
npm install {{ package }}
npm install {{ package.name }}
```

</pfe-band>