From eb4b042133d56b26973a10b7f027a9be30c9d11c Mon Sep 17 00:00:00 2001 From: Benny Powers Date: Wed, 16 Jul 2025 18:32:43 +0300 Subject: [PATCH 1/6] docs: cem config for elements --- elements/.config/cem.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/elements/.config/cem.yaml b/elements/.config/cem.yaml index 2ae51063a1..9362bca3c4 100644 --- a/elements/.config/cem.yaml +++ b/elements/.config/cem.yaml @@ -9,6 +9,6 @@ generate: output: custom-elements.json noDefaultExcludes: false demoDiscovery: - fileGlob: ./*/demo/*.html - urlPattern: (?P[\\w-]+)/demo/(?P[\\w-]+).html - urlTemplate: https://patternflyelements.org/components/{tag}/{demo}/ + fileGlob: '*/demo/*.html' + urlPattern: pf-(?P[\w-]+)/demo/(?P[\w-]+).html + urlTemplate: https://patternflyelements.org/components/{tag}/demo/{demo}/ From 1a44d6087b8cbd9ed248e2f1c74c5b2e91ee7856 Mon Sep 17 00:00:00 2001 From: Benny Powers Date: Wed, 16 Jul 2025 18:33:12 +0300 Subject: [PATCH 2/6] fix(tools): filter demos in dev server: only show those directly relevant to tagName --- tools/pfe-tools/dev-server/plugins/dev-server-templates.ts | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/tools/pfe-tools/dev-server/plugins/dev-server-templates.ts b/tools/pfe-tools/dev-server/plugins/dev-server-templates.ts index df856c2908..ac1aeff77c 100644 --- a/tools/pfe-tools/dev-server/plugins/dev-server-templates.ts +++ b/tools/pfe-tools/dev-server/plugins/dev-server-templates.ts @@ -36,7 +36,8 @@ async function getDemos(config: PfeDevServerInternalConfig) { manifest .getTagNames() .flatMap(tagName => - manifest.getDemoMetadata(tagName, config as PfeDevServerInternalConfig))); + manifest.getDemoMetadata(tagName, config as PfeDevServerInternalConfig) + .filter(demo => demo.filePath?.includes(tagName)))); } async function getTemplateContent(demo?: DemoRecord) { @@ -76,5 +77,3 @@ export function pfeDevServerTemplateMiddleware(config: PfeDevServerInternalConfi return next(); }; } - - From 9e8ac505de348a744f71b77fdeb2185ece219ddd Mon Sep 17 00:00:00 2001 From: Benny Powers Date: Wed, 16 Jul 2025 18:36:12 +0300 Subject: [PATCH 3/6] fix(tools): redirect demos based on filename --- tools/pfe-tools/dev-server/config.ts | 1 + .../dev-server/plugins/dev-server-templates.ts | 12 +++++++++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/tools/pfe-tools/dev-server/config.ts b/tools/pfe-tools/dev-server/config.ts index 5c2cf90f7c..6bd91086e8 100644 --- a/tools/pfe-tools/dev-server/config.ts +++ b/tools/pfe-tools/dev-server/config.ts @@ -23,6 +23,7 @@ import { join } from 'node:path'; const replace = fromRollup(rollupReplace); type BaseConfig = DevServerConfig & PfeConfig; + export interface PfeDevServerConfigOptions extends BaseConfig { hostname?: string; litcssOptions?: LitCSSOptions; diff --git a/tools/pfe-tools/dev-server/plugins/dev-server-templates.ts b/tools/pfe-tools/dev-server/plugins/dev-server-templates.ts index ac1aeff77c..4798928c8a 100644 --- a/tools/pfe-tools/dev-server/plugins/dev-server-templates.ts +++ b/tools/pfe-tools/dev-server/plugins/dev-server-templates.ts @@ -37,7 +37,17 @@ async function getDemos(config: PfeDevServerInternalConfig) { .getTagNames() .flatMap(tagName => manifest.getDemoMetadata(tagName, config as PfeDevServerInternalConfig) - .filter(demo => demo.filePath?.includes(tagName)))); + .filter(demo => demo.filePath?.includes(tagName)) + .map(demo => { + if (demo.filePath?.endsWith(`${tagName}.html`) || demo.filePath?.endsWith('index.html')) { + return { + ...demo, + permalink: dirname(demo.permalink), + }; + } else { + return demo; + } + }))); } async function getTemplateContent(demo?: DemoRecord) { From 35b5d8b71f4076b2e7211199a7ce25c021d8a329 Mon Sep 17 00:00:00 2001 From: Benny Powers Date: Wed, 16 Jul 2025 20:39:12 +0300 Subject: [PATCH 4/6] docs: fix build --- docs/components.11tydata.cjs | 14 ++++++++++++++ docs/{components => }/components.md | 17 ----------------- docs/components/demos.11tydata.cjs | 16 +++++++++++++++- 3 files changed, 29 insertions(+), 18 deletions(-) create mode 100644 docs/components.11tydata.cjs rename docs/{components => }/components.md (70%) diff --git a/docs/components.11tydata.cjs b/docs/components.11tydata.cjs new file mode 100644 index 0000000000..5c968c42fb --- /dev/null +++ b/docs/components.11tydata.cjs @@ -0,0 +1,14 @@ +module.exports = { + layout: 'layout-basic.njk', + templateEngineOverride: 'njk,md', + tags: ['component'], + permalink: '/components/{{ element.slug }}/index.html', + package: '{{ element.package }}', + description: '{{ element.description }}', + pagination: { + data: 'elements', + size: 1, + alias: 'element', + before: xs => xs.filter(x => !!x.docsTemplatePath), + }, +}; diff --git a/docs/components/components.md b/docs/components.md similarity index 70% rename from docs/components/components.md rename to docs/components.md index c121c174ec..dd9d4082fa 100644 --- a/docs/components/components.md +++ b/docs/components.md @@ -1,20 +1,3 @@ ----js -{ - layout: 'layout-basic.njk', - templateEngineOverride: 'njk,md', - tags: ['component'], - permalink: '/components/{{ element.slug }}/index.html', - package: '{{ element.package }}', - description: '{{ element.description }}', - pagination: { - data: 'elements', - size: 1, - alias: 'element', - before: xs => xs.filter(x => !!x.docsTemplatePath), - } -} ---- -