Skip to content

Commit fe2ce5e

Browse files
committed
fix(docs): fix docs build after pf-v5-* rename
- Update main.mjs to import PfV5Icon from renamed path - Update pfe-assets.cjs regex and JSDoc for pf-v5-* paths - Pass prefix option to PfeAssetsPlugin in eleventy config - Replace broken generateImportMap shortcodes with static import maps (jspm.io can't resolve unpublished pf-v5-* paths) - Fix pre-existing TS build errors: use Router.Middleware instead of non-existent RouterMiddleware export, remove stale @ts-expect-error directive - Fix pre-existing slug function call using deprecated eleventyConfig.javascript.functions API Assisted-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 0cb8873 commit fe2ce5e

5 files changed

Lines changed: 9 additions & 40 deletions

File tree

docs/get-started.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,16 @@ title: Get started
4747
In this example, we load the [card](/components/card/) modules using an importmap from JSPM.
4848

4949
```html
50-
{% generateImportMap %}
50+
<script type="importmap">
51+
{
52+
"imports": {
53+
"@patternfly/elements/": "https://ga.jspm.io/npm:@patternfly/elements/"
54+
}
55+
}
56+
</script>
5157
<script type="module">
5258
import "@patternfly/elements/pf-v5-card/pf-v5-card.js";
5359
</script>
54-
{% endgenerateImportMap %}
5560
```
5661

5762
To learn more about how to create importmaps, read our [creating an import map](/docs/develop/import-maps/) section, and go into more detail at [developer.mozilla.org](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script/type/importmap) or the [import map specification](https://html.spec.whatwg.org/multipage/webappapis.html#import-maps).

docs/main.mjs

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,5 @@
11
import '@rhds/elements/rh-footer/rh-footer-universal.js';
22
import { PfV5Icon } from '@patternfly/elements/pf-v5-icon/pf-v5-icon.js';
3-
import '@patternfly/elements/pf-v5-accordion/pf-v5-accordion.js';
4-
import '@patternfly/elements/pf-v5-alert/pf-v5-alert.js';
5-
import '@patternfly/elements/pf-v5-avatar/pf-v5-avatar.js';
6-
import '@patternfly/elements/pf-v5-back-to-top/pf-v5-back-to-top.js';
7-
import '@patternfly/elements/pf-v5-background-image/pf-v5-background-image.js';
8-
import '@patternfly/elements/pf-v5-badge/pf-v5-badge.js';
9-
import '@patternfly/elements/pf-v5-banner/pf-v5-banner.js';
10-
import '@patternfly/elements/pf-v5-button/pf-v5-button.js';
11-
import '@patternfly/elements/pf-v5-card/pf-v5-card.js';
12-
import '@patternfly/elements/pf-v5-chip/pf-v5-chip.js';
13-
import '@patternfly/elements/pf-v5-clipboard-copy/pf-v5-clipboard-copy.js';
14-
import '@patternfly/elements/pf-v5-code-block/pf-v5-code-block.js';
15-
import '@patternfly/elements/pf-v5-dropdown/pf-v5-dropdown.js';
16-
import '@patternfly/elements/pf-v5-helper-text/pf-v5-helper-text.js';
17-
import '@patternfly/elements/pf-v5-hint/pf-v5-hint.js';
18-
import '@patternfly/elements/pf-v5-jump-links/pf-v5-jump-links.js';
19-
import '@patternfly/elements/pf-v5-label/pf-v5-label.js';
20-
import '@patternfly/elements/pf-v5-label-group/pf-v5-label-group.js';
21-
import '@patternfly/elements/pf-v5-modal/pf-v5-modal.js';
22-
import '@patternfly/elements/pf-v5-panel/pf-v5-panel.js';
23-
import '@patternfly/elements/pf-v5-popover/pf-v5-popover.js';
24-
import '@patternfly/elements/pf-v5-progress/pf-v5-progress.js';
25-
import '@patternfly/elements/pf-v5-progress-stepper/pf-v5-progress-stepper.js';
26-
import '@patternfly/elements/pf-v5-search-input/pf-v5-search-input.js';
27-
import '@patternfly/elements/pf-v5-select/pf-v5-select.js';
28-
import '@patternfly/elements/pf-v5-spinner/pf-v5-spinner.js';
29-
import '@patternfly/elements/pf-v5-switch/pf-v5-switch.js';
30-
import '@patternfly/elements/pf-v5-table/pf-v5-table.js';
31-
import '@patternfly/elements/pf-v5-tabs/pf-v5-tabs.js';
32-
import '@patternfly/elements/pf-v5-text-area/pf-v5-text-area.js';
33-
import '@patternfly/elements/pf-v5-text-input/pf-v5-text-input.js';
34-
import '@patternfly/elements/pf-v5-tile/pf-v5-tile.js';
35-
import '@patternfly/elements/pf-v5-timestamp/pf-v5-timestamp.js';
36-
import '@patternfly/elements/pf-v5-tooltip/pf-v5-tooltip.js';
373

384
// if `/v2/` path load icons from static directory
395
if (document.location.href.includes('/v2/')) {

eleventy.config.cjs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@ const markdownItAnchor = require('markdown-it-anchor');
1919

2020
const { $ } = require('execa');
2121
const path = require('node:path');
22-
const _slugify = require('@sindresorhus/slugify');
23-
const slugify = _slugify.default ?? _slugify;
22+
const slugify = require('@sindresorhus/slugify');
2423

2524
/** @param {import('@11ty/eleventy/src/UserConfig')} eleventyConfig */
2625
module.exports = function(eleventyConfig) {

tools/pfe-tools/dev-server/plugins/dev-server-router.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { makeDemoEnv } from '../../environment.js';
77
import { deslugify } from '../../config.js';
88

99
type PfeMiddleware =
10-
(config: PfeDevServerInternalConfig) => Middleware<DefaultState, DefaultContext>;
10+
(config: PfeDevServerInternalConfig) => Router.Middleware<DefaultState, DefaultContext>;
1111

1212
/**
1313
* The environment file contains information from the serverside

tools/pfe-tools/test/create-fixture.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import type { TemplateResult } from 'lit';
22
import { chai, fixtureCleanup, fixture } from '@open-wc/testing';
3-
// @ts-expect-error: colorjs.io types not resolved with Node moduleResolution on Windows CI
43
import Color from 'colorjs.io';
54

65
/**

0 commit comments

Comments
 (0)