@kamod-ch/preactpress 1.0.0 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +87 -49
- package/bin/preactpress.mjs +5 -5
- package/dist/client/app.d.ts +1 -1
- package/dist/client/app.d.ts.map +1 -1
- package/dist/client/app.js +55 -42
- package/dist/client/app.js.map +1 -1
- package/dist/client/entry-client.js +11 -12
- package/dist/client/entry-client.js.map +1 -1
- package/dist/client/entry-ssr.d.ts +2 -2
- package/dist/client/entry-ssr.d.ts.map +1 -1
- package/dist/client/entry-ssr.js +16 -16
- package/dist/client/entry-ssr.js.map +1 -1
- package/dist/client/index.d.ts +3 -2
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +2 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/loadPage.d.ts +2 -1
- package/dist/client/loadPage.d.ts.map +1 -1
- package/dist/client/loadPage.js +15 -12
- package/dist/client/loadPage.js.map +1 -1
- package/dist/client/prefetchLinks.js +4 -4
- package/dist/client/prefetchLinks.js.map +1 -1
- package/dist/client/theme-default/AlgoliaSearch.d.ts +3 -3
- package/dist/client/theme-default/AlgoliaSearch.d.ts.map +1 -1
- package/dist/client/theme-default/AlgoliaSearch.js +15 -15
- package/dist/client/theme-default/AlgoliaSearch.js.map +1 -1
- package/dist/client/theme-default/Features.d.ts +2 -2
- package/dist/client/theme-default/Features.d.ts.map +1 -1
- package/dist/client/theme-default/Features.js +10 -8
- package/dist/client/theme-default/Features.js.map +1 -1
- package/dist/client/theme-default/Hero.d.ts +2 -2
- package/dist/client/theme-default/Hero.d.ts.map +1 -1
- package/dist/client/theme-default/Hero.js +9 -7
- package/dist/client/theme-default/Hero.js.map +1 -1
- package/dist/client/theme-default/Layout.d.ts +3 -3
- package/dist/client/theme-default/Layout.d.ts.map +1 -1
- package/dist/client/theme-default/Layout.js +56 -99
- package/dist/client/theme-default/Layout.js.map +1 -1
- package/dist/client/theme-default/Logo.d.ts +2 -2
- package/dist/client/theme-default/Logo.d.ts.map +1 -1
- package/dist/client/theme-default/Logo.js +8 -8
- package/dist/client/theme-default/Logo.js.map +1 -1
- package/dist/client/theme-default/NavLinks.d.ts +2 -2
- package/dist/client/theme-default/NavLinks.d.ts.map +1 -1
- package/dist/client/theme-default/NavLinks.js +3 -3
- package/dist/client/theme-default/NavLinks.js.map +1 -1
- package/dist/client/theme-default/SidebarNav.d.ts +2 -2
- package/dist/client/theme-default/SidebarNav.d.ts.map +1 -1
- package/dist/client/theme-default/SidebarNav.js +3 -3
- package/dist/client/theme-default/SidebarNav.js.map +1 -1
- package/dist/client/theme-default/SocialLinks.d.ts +2 -2
- package/dist/client/theme-default/SocialLinks.d.ts.map +1 -1
- package/dist/client/theme-default/SocialLinks.js +1 -1
- package/dist/client/theme-default/SocialLinks.js.map +1 -1
- package/dist/client/theme-default/ThemeToggle.d.ts +2 -3
- package/dist/client/theme-default/ThemeToggle.d.ts.map +1 -1
- package/dist/client/theme-default/ThemeToggle.js +2 -30
- package/dist/client/theme-default/ThemeToggle.js.map +1 -1
- package/dist/client/theme-default/index.d.ts +1 -1
- package/dist/client/theme-default/index.d.ts.map +1 -1
- package/dist/client/theme-default/index.js +1 -1
- package/dist/client/theme-default/index.js.map +1 -1
- package/dist/client/theme-utils.d.ts +24 -0
- package/dist/client/theme-utils.d.ts.map +1 -0
- package/dist/client/theme-utils.js +107 -0
- package/dist/client/theme-utils.js.map +1 -0
- package/dist/client/types.d.ts +5 -5
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client/usePageHead.d.ts +2 -2
- package/dist/client/usePageHead.d.ts.map +1 -1
- package/dist/client/usePageHead.js +61 -56
- package/dist/client/usePageHead.js.map +1 -1
- package/dist/client/useSiteSearch.d.ts.map +1 -1
- package/dist/client/useSiteSearch.js +8 -8
- package/dist/client/useSiteSearch.js.map +1 -1
- package/dist/node/build.d.ts +1 -1
- package/dist/node/build.d.ts.map +1 -1
- package/dist/node/build.js +105 -96
- package/dist/node/build.js.map +1 -1
- package/dist/node/buildCache.d.ts.map +1 -1
- package/dist/node/buildCache.js +7 -7
- package/dist/node/buildCache.js.map +1 -1
- package/dist/node/check.d.ts +1 -1
- package/dist/node/check.d.ts.map +1 -1
- package/dist/node/check.js +52 -52
- package/dist/node/check.js.map +1 -1
- package/dist/node/cli.js +61 -64
- package/dist/node/cli.js.map +1 -1
- package/dist/node/config-helpers.d.ts +4 -4
- package/dist/node/config-helpers.d.ts.map +1 -1
- package/dist/node/config-helpers.js +1 -1
- package/dist/node/config-helpers.js.map +1 -1
- package/dist/node/config.d.ts +4 -4
- package/dist/node/config.d.ts.map +1 -1
- package/dist/node/config.js +37 -40
- package/dist/node/config.js.map +1 -1
- package/dist/node/content.d.ts +4 -4
- package/dist/node/content.d.ts.map +1 -1
- package/dist/node/content.js +28 -28
- package/dist/node/content.js.map +1 -1
- package/dist/node/createContentLoader.d.ts +1 -1
- package/dist/node/createContentLoader.d.ts.map +1 -1
- package/dist/node/createContentLoader.js +3 -3
- package/dist/node/createContentLoader.js.map +1 -1
- package/dist/node/devCss.d.ts +1 -1
- package/dist/node/devCss.d.ts.map +1 -1
- package/dist/node/devCss.js +5 -6
- package/dist/node/devCss.js.map +1 -1
- package/dist/node/devSsr.d.ts +3 -3
- package/dist/node/devSsr.d.ts.map +1 -1
- package/dist/node/devSsr.js +32 -32
- package/dist/node/devSsr.js.map +1 -1
- package/dist/node/dynamicRoutes.d.ts +2 -2
- package/dist/node/dynamicRoutes.d.ts.map +1 -1
- package/dist/node/dynamicRoutes.js +24 -24
- package/dist/node/dynamicRoutes.js.map +1 -1
- package/dist/node/favicon.d.ts +2 -2
- package/dist/node/favicon.d.ts.map +1 -1
- package/dist/node/favicon.js +26 -24
- package/dist/node/favicon.js.map +1 -1
- package/dist/node/feed.d.ts +2 -2
- package/dist/node/feed.d.ts.map +1 -1
- package/dist/node/feed.js +18 -16
- package/dist/node/feed.js.map +1 -1
- package/dist/node/hooks.d.ts +2 -2
- package/dist/node/hooks.d.ts.map +1 -1
- package/dist/node/hooks.js +1 -1
- package/dist/node/hooks.js.map +1 -1
- package/dist/node/html.d.ts +8 -8
- package/dist/node/html.d.ts.map +1 -1
- package/dist/node/html.js +75 -64
- package/dist/node/html.js.map +1 -1
- package/dist/node/index.d.ts +11 -11
- package/dist/node/index.d.ts.map +1 -1
- package/dist/node/index.js +8 -8
- package/dist/node/index.js.map +1 -1
- package/dist/node/init.d.ts +2 -0
- package/dist/node/init.d.ts.map +1 -1
- package/dist/node/init.js +59 -27
- package/dist/node/init.js.map +1 -1
- package/dist/node/lastUpdated.d.ts +2 -2
- package/dist/node/lastUpdated.d.ts.map +1 -1
- package/dist/node/lastUpdated.js +7 -4
- package/dist/node/lastUpdated.js.map +1 -1
- package/dist/node/loadSiteModule.js +2 -2
- package/dist/node/loadSiteModule.js.map +1 -1
- package/dist/node/markdown.d.ts +2 -2
- package/dist/node/markdown.d.ts.map +1 -1
- package/dist/node/markdown.js +110 -110
- package/dist/node/markdown.js.map +1 -1
- package/dist/node/markdownHeadings.d.ts +1 -1
- package/dist/node/markdownHeadings.d.ts.map +1 -1
- package/dist/node/markdownHeadings.js +11 -11
- package/dist/node/markdownHeadings.js.map +1 -1
- package/dist/node/markdownInclude.d.ts.map +1 -1
- package/dist/node/markdownInclude.js +11 -11
- package/dist/node/markdownInclude.js.map +1 -1
- package/dist/node/markdownSnippets.d.ts.map +1 -1
- package/dist/node/markdownSnippets.js +34 -34
- package/dist/node/markdownSnippets.js.map +1 -1
- package/dist/node/mdx.d.ts +1 -1
- package/dist/node/mdx.d.ts.map +1 -1
- package/dist/node/mdx.js +4 -4
- package/dist/node/mdx.js.map +1 -1
- package/dist/node/packageRoot.d.ts.map +1 -1
- package/dist/node/packageRoot.js +4 -4
- package/dist/node/packageRoot.js.map +1 -1
- package/dist/node/pageDataLoaders.d.ts +2 -2
- package/dist/node/pageDataLoaders.d.ts.map +1 -1
- package/dist/node/pageDataLoaders.js +24 -20
- package/dist/node/pageDataLoaders.js.map +1 -1
- package/dist/node/paths.d.ts.map +1 -1
- package/dist/node/paths.js +4 -4
- package/dist/node/paths.js.map +1 -1
- package/dist/node/plugin.d.ts +3 -3
- package/dist/node/plugin.d.ts.map +1 -1
- package/dist/node/plugin.js +66 -66
- package/dist/node/plugin.js.map +1 -1
- package/dist/node/resolveDeps.js +10 -10
- package/dist/node/resolveDeps.js.map +1 -1
- package/dist/node/serve.d.ts.map +1 -1
- package/dist/node/serve.js +13 -15
- package/dist/node/serve.js.map +1 -1
- package/dist/node/server.d.ts +3 -3
- package/dist/node/server.d.ts.map +1 -1
- package/dist/node/server.js +28 -25
- package/dist/node/server.js.map +1 -1
- package/dist/node/siteConfig.d.ts +12 -12
- package/dist/node/siteConfig.d.ts.map +1 -1
- package/dist/node/tagIndex.d.ts +5 -5
- package/dist/node/tagIndex.d.ts.map +1 -1
- package/dist/node/tagIndex.js +10 -10
- package/dist/node/tagIndex.js.map +1 -1
- package/dist/shared/contentChunk.d.ts.map +1 -1
- package/dist/shared/contentChunk.js +6 -6
- package/dist/shared/contentChunk.js.map +1 -1
- package/dist/shared/contentSchema.d.ts.map +1 -1
- package/dist/shared/contentSchema.js +11 -11
- package/dist/shared/contentSchema.js.map +1 -1
- package/dist/shared/deadLinks.d.ts.map +1 -1
- package/dist/shared/deadLinks.js +6 -6
- package/dist/shared/deadLinks.js.map +1 -1
- package/dist/shared/escapeHtml.js +4 -4
- package/dist/shared/escapeHtml.js.map +1 -1
- package/dist/shared/index.d.ts +14 -14
- package/dist/shared/index.d.ts.map +1 -1
- package/dist/shared/index.js +14 -14
- package/dist/shared/index.js.map +1 -1
- package/dist/shared/locale.d.ts +1 -1
- package/dist/shared/locale.d.ts.map +1 -1
- package/dist/shared/locale.js +10 -10
- package/dist/shared/locale.js.map +1 -1
- package/dist/shared/pageChrome.d.ts +4 -4
- package/dist/shared/pageChrome.d.ts.map +1 -1
- package/dist/shared/pageChrome.js +21 -21
- package/dist/shared/pageChrome.js.map +1 -1
- package/dist/shared/pageHead.d.ts +1 -1
- package/dist/shared/pageHead.d.ts.map +1 -1
- package/dist/shared/pageHead.js +4 -4
- package/dist/shared/pageHead.js.map +1 -1
- package/dist/shared/pageMeta.d.ts +5 -5
- package/dist/shared/pageMeta.d.ts.map +1 -1
- package/dist/shared/pageMeta.js +15 -17
- package/dist/shared/pageMeta.js.map +1 -1
- package/dist/shared/rewrites.d.ts +1 -1
- package/dist/shared/rewrites.d.ts.map +1 -1
- package/dist/shared/rewrites.js +2 -2
- package/dist/shared/rewrites.js.map +1 -1
- package/dist/shared/route.js +5 -5
- package/dist/shared/route.js.map +1 -1
- package/dist/shared/scrollRestoration.d.ts +10 -0
- package/dist/shared/scrollRestoration.d.ts.map +1 -0
- package/dist/shared/scrollRestoration.js +66 -0
- package/dist/shared/scrollRestoration.js.map +1 -0
- package/dist/shared/search.d.ts +3 -3
- package/dist/shared/search.d.ts.map +1 -1
- package/dist/shared/search.js +18 -15
- package/dist/shared/search.js.map +1 -1
- package/dist/shared/sidebar.d.ts +1 -1
- package/dist/shared/sidebar.d.ts.map +1 -1
- package/dist/shared/sidebar.js +4 -4
- package/dist/shared/sidebar.js.map +1 -1
- package/dist/shared/slug.d.ts +1 -1
- package/dist/shared/slug.d.ts.map +1 -1
- package/dist/shared/slug.js +5 -5
- package/dist/shared/slug.js.map +1 -1
- package/dist/shared/socialIcons.d.ts.map +1 -1
- package/dist/shared/socialIcons.js +4 -4
- package/dist/shared/socialIcons.js.map +1 -1
- package/dist/shared/tags.js +8 -8
- package/dist/shared/tags.js.map +1 -1
- package/dist/shared/theme.d.ts +1 -1
- package/dist/shared/theme.d.ts.map +1 -1
- package/dist/shared/theme.js +16 -10
- package/dist/shared/theme.js.map +1 -1
- package/dist/shared/themeLabels.d.ts +1 -1
- package/dist/shared/themeLabels.d.ts.map +1 -1
- package/dist/shared/themeLabels.js +26 -26
- package/dist/shared/themeLabels.js.map +1 -1
- package/dist/shared/url.d.ts.map +1 -1
- package/dist/shared/url.js +3 -3
- package/dist/shared/url.js.map +1 -1
- package/package.json +33 -9
- package/src/client/app.tsx +111 -92
- package/src/client/entry-client.tsx +17 -19
- package/src/client/entry-ssr.tsx +33 -33
- package/src/client/index.ts +16 -2
- package/src/client/loadPage.ts +41 -38
- package/src/client/prefetchLinks.ts +30 -30
- package/src/client/theme-default/AlgoliaSearch.tsx +46 -46
- package/src/client/theme-default/Features.tsx +27 -21
- package/src/client/theme-default/Hero.tsx +22 -18
- package/src/client/theme-default/Layout.tsx +189 -244
- package/src/client/theme-default/Logo.tsx +30 -40
- package/src/client/theme-default/NavLinks.tsx +21 -21
- package/src/client/theme-default/SidebarNav.tsx +29 -29
- package/src/client/theme-default/SocialLinks.tsx +11 -11
- package/src/client/theme-default/ThemeToggle.tsx +2 -78
- package/src/client/theme-default/index.ts +1 -1
- package/src/client/theme-default/styles.css +30 -21
- package/src/client/theme-utils.tsx +184 -0
- package/src/client/types.ts +30 -24
- package/src/client/usePageHead.ts +128 -128
- package/src/client/useSiteSearch.ts +34 -34
- package/src/client/virtual.d.ts +76 -76
- package/src/shared/contentChunk.ts +6 -6
- package/src/shared/contentSchema.ts +52 -49
- package/src/shared/deadLinks.ts +16 -16
- package/src/shared/escapeHtml.ts +5 -5
- package/src/shared/index.ts +21 -25
- package/src/shared/locale.ts +46 -46
- package/src/shared/pageChrome.ts +123 -123
- package/src/shared/pageHead.ts +16 -16
- package/src/shared/pageMeta.ts +79 -79
- package/src/shared/rewrites.ts +14 -16
- package/src/shared/route.ts +7 -7
- package/src/shared/scrollRestoration.ts +70 -0
- package/src/shared/search.ts +56 -52
- package/src/shared/sidebar.ts +28 -28
- package/src/shared/slug.ts +13 -13
- package/src/shared/socialIcons.ts +12 -14
- package/src/shared/tags.ts +20 -20
- package/src/shared/theme.ts +22 -13
- package/src/shared/themeLabels.ts +45 -45
- package/src/shared/url.ts +6 -10
- package/templates/default/.preactpress/config.ts +17 -17
- package/templates/default/README.md +16 -16
- package/templates/default/guide/first-five-minutes.md +21 -21
- package/templates/default/index.html +1 -1
- package/templates/default/index.md +9 -9
- package/templates/default/package.json +1 -1
- package/templates/default/pnpm-lock.yaml +5 -5
- package/templates/docs/.preactpress/config.ts +76 -56
- package/templates/docs/README.md +6 -6
- package/templates/docs/components/BenefitsGrid.tsx +45 -0
- package/templates/docs/components/CliBlock.tsx +38 -0
- package/templates/docs/components/ComparisonTable.tsx +60 -0
- package/templates/docs/components/CopyableCommand.tsx +86 -0
- package/templates/docs/components/Counter.tsx +7 -5
- package/templates/docs/components/MarketingHero.tsx +63 -0
- package/templates/docs/components/MdxDemo.tsx +96 -0
- package/templates/docs/components/References.tsx +62 -0
- package/templates/docs/components/TemplateGallery.tsx +46 -0
- package/templates/docs/components/marketing.css +992 -0
- package/templates/docs/examples/algolia-docsearch.md +33 -0
- package/templates/docs/examples/content-loader.data.ts +11 -0
- package/templates/docs/examples/content-loader.md +29 -0
- package/templates/docs/examples/dynamic-routes.md +16 -0
- package/templates/docs/examples/static-assets.md +13 -0
- package/templates/docs/guide/advanced.md +4 -4
- package/templates/docs/guide/commands.md +10 -10
- package/templates/docs/guide/configuration.md +43 -43
- package/templates/docs/guide/creating-pages.md +60 -39
- package/templates/docs/guide/custom-themes.md +9 -9
- package/templates/docs/guide/deploy.md +29 -29
- package/templates/docs/guide/first-five-minutes.md +22 -22
- package/templates/docs/guide/getting-started.md +29 -31
- package/templates/docs/guide/markdown-and-mdx.md +1 -1
- package/templates/docs/guide/routing.md +40 -40
- package/templates/docs/guide/what-is-preactpress.md +18 -18
- package/templates/docs/index.html +1 -1
- package/templates/docs/index.mdx +25 -0
- package/templates/docs/interactive.mdx +1 -1
- package/templates/docs/markdown-examples.md +73 -21
- package/templates/docs/package.json +1 -1
- package/templates/docs/packages/[pkg].md +15 -0
- package/templates/docs/packages/[pkg].paths.ts +20 -0
- package/templates/docs/parts/include-body.md +1 -0
- package/templates/docs/pnpm-lock.yaml +5 -5
- package/templates/docs/public/preactpress-example.txt +1 -0
- package/templates/docs/snippets/greet.ts +1 -1
- package/templates/hono/.preactpress/config.ts +65 -65
- package/templates/hono/.preactpress/theme/CodeSnippet.tsx +15 -15
- package/templates/hono/.preactpress/theme/FeatureGrid.tsx +7 -7
- package/templates/hono/.preactpress/theme/Hero.tsx +13 -13
- package/templates/hono/.preactpress/theme/Layout.tsx +122 -164
- package/templates/hono/.preactpress/theme/Logo.tsx +6 -6
- package/templates/hono/.preactpress/theme/ThemeToggle.tsx +3 -70
- package/templates/hono/.preactpress/theme/hono.css +31 -14
- package/templates/hono/README.md +17 -15
- package/templates/hono/components/Counter.tsx +7 -5
- package/templates/hono/de/guide/configuration.md +18 -20
- package/templates/hono/de/guide/deploy.md +29 -29
- package/templates/hono/de/guide/first-five-minutes.md +21 -21
- package/templates/hono/de/guide/getting-started.md +29 -29
- package/templates/hono/de/guide/routing.md +26 -25
- package/templates/hono/de/guide/seiten-erstellen.md +39 -39
- package/templates/hono/de/guide/what-is-preactpress.md +18 -18
- package/templates/hono/de/index.mdx +20 -17
- package/templates/hono/de/interactive.mdx +1 -1
- package/templates/hono/de/markdown-examples.md +6 -6
- package/templates/hono/de/parts/include-body.md +1 -0
- package/templates/hono/de/snippets/greet.ts +1 -1
- package/templates/hono/guide/configuration.md +25 -25
- package/templates/hono/guide/creating-pages.md +39 -39
- package/templates/hono/guide/deploy.md +29 -29
- package/templates/hono/guide/first-five-minutes.md +21 -21
- package/templates/hono/guide/getting-started.md +29 -29
- package/templates/hono/guide/routing.md +40 -40
- package/templates/hono/guide/what-is-preactpress.md +18 -18
- package/templates/hono/index.html +1 -1
- package/templates/hono/index.mdx +21 -17
- package/templates/hono/interactive.mdx +1 -1
- package/templates/hono/markdown-examples.md +6 -6
- package/templates/hono/package.json +1 -1
- package/templates/hono/parts/include-body.md +1 -0
- package/templates/hono/pnpm-lock.yaml +5 -5
- package/templates/hono/snippets/greet.ts +1 -1
- package/templates/magazine/.preactpress/config.ts +19 -19
- package/templates/magazine/.preactpress/theme/Layout.tsx +69 -172
- package/templates/magazine/.preactpress/theme/TeaserGrid.tsx +14 -14
- package/templates/magazine/.preactpress/theme/ThemeToggle.tsx +4 -70
- package/templates/magazine/.preactpress/theme/magazine.css +13 -8
- package/templates/magazine/README.md +30 -0
- package/templates/magazine/article-markets.md +2 -2
- package/templates/magazine/article-tech.mdx +10 -10
- package/templates/magazine/index.data.ts +9 -9
- package/templates/magazine/index.html +5 -1
- package/templates/magazine/index.mdx +1 -1
- package/templates/magazine/package.json +1 -1
- package/templates/magazine/pnpm-lock.yaml +2917 -0
- package/templates/docs/about.md +0 -10
- package/templates/docs/dist/404.html +0 -29
- package/templates/docs/dist/about/index.html +0 -32
- package/templates/docs/dist/assets/esm-DzlBxN5p.js +0 -110
- package/templates/docs/dist/assets/interactive-64o6YwrR.js +0 -9
- package/templates/docs/dist/assets/interactive-BedCloEw.js +0 -9
- package/templates/docs/dist/assets/main-BVLeh8GO.js +0 -1
- package/templates/docs/dist/assets/main-CreUBb3N.js +0 -1
- package/templates/docs/dist/assets/main-oodK-zZy.css +0 -2
- package/templates/docs/dist/de/guide/getting-started/index.html +0 -36
- package/templates/docs/dist/de/guide/what-is-preactpress/index.html +0 -38
- package/templates/docs/dist/de/index.html +0 -29
- package/templates/docs/dist/favicon-32.png +0 -0
- package/templates/docs/dist/favicon.png +0 -0
- package/templates/docs/dist/favicon.svg +0 -28
- package/templates/docs/dist/guide/advanced/index.html +0 -53
- package/templates/docs/dist/guide/commands/index.html +0 -89
- package/templates/docs/dist/guide/configuration/index.html +0 -196
- package/templates/docs/dist/guide/creating-pages/index.html +0 -234
- package/templates/docs/dist/guide/custom-themes/index.html +0 -52
- package/templates/docs/dist/guide/default-theme/index.html +0 -53
- package/templates/docs/dist/guide/deploy/index.html +0 -195
- package/templates/docs/dist/guide/first-five-minutes/index.html +0 -99
- package/templates/docs/dist/guide/getting-started/index.html +0 -173
- package/templates/docs/dist/guide/markdown-and-mdx/index.html +0 -59
- package/templates/docs/dist/guide/routing/index.html +0 -192
- package/templates/docs/dist/guide/what-is-preactpress/index.html +0 -141
- package/templates/docs/dist/index.html +0 -30
- package/templates/docs/dist/interactive/index.html +0 -37
- package/templates/docs/dist/markdown-examples/index.html +0 -231
- package/templates/docs/dist/preactpress-content/404.json +0 -8
- package/templates/docs/dist/preactpress-content/_index.json +0 -50
- package/templates/docs/dist/preactpress-content/about.json +0 -15
- package/templates/docs/dist/preactpress-content/de.json +0 -45
- package/templates/docs/dist/preactpress-content/de__guide__getting-started.json +0 -26
- package/templates/docs/dist/preactpress-content/de__guide__what-is-preactpress.json +0 -21
- package/templates/docs/dist/preactpress-content/guide__advanced.json +0 -46
- package/templates/docs/dist/preactpress-content/guide__commands.json +0 -26
- package/templates/docs/dist/preactpress-content/guide__configuration.json +0 -51
- package/templates/docs/dist/preactpress-content/guide__creating-pages.json +0 -71
- package/templates/docs/dist/preactpress-content/guide__custom-themes.json +0 -15
- package/templates/docs/dist/preactpress-content/guide__default-theme.json +0 -36
- package/templates/docs/dist/preactpress-content/guide__deploy.json +0 -56
- package/templates/docs/dist/preactpress-content/guide__first-five-minutes.json +0 -36
- package/templates/docs/dist/preactpress-content/guide__getting-started.json +0 -51
- package/templates/docs/dist/preactpress-content/guide__markdown-and-mdx.json +0 -31
- package/templates/docs/dist/preactpress-content/guide__routing.json +0 -71
- package/templates/docs/dist/preactpress-content/guide__what-is-preactpress.json +0 -51
- package/templates/docs/dist/preactpress-content/markdown-examples.json +0 -71
- package/templates/docs/dist/preactpress-content/tags__markdown.json +0 -16
- package/templates/docs/dist/preactpress-search.json +0 -166
- package/templates/docs/dist/preactpress-theme.js +0 -1
- package/templates/docs/dist/tags/markdown/index.html +0 -32
- package/templates/docs/index.md +0 -28
- package/templates/hono/dist/404.html +0 -29
- package/templates/hono/dist/README/index.html +0 -104
- package/templates/hono/dist/about/index.html +0 -32
- package/templates/hono/dist/assets/Counter-CCEByS-J.js +0 -1
- package/templates/hono/dist/assets/Hero--o6WMNvm.js +0 -2
- package/templates/hono/dist/assets/de-D5r6Ye70.js +0 -10
- package/templates/hono/dist/assets/hono-BXWYYdyv.js +0 -10
- package/templates/hono/dist/assets/interactive-Bxo-WBpC.js +0 -9
- package/templates/hono/dist/assets/interactive-BznI4IQ3.js +0 -9
- package/templates/hono/dist/assets/main-Bqi-VFEk.js +0 -2
- package/templates/hono/dist/assets/main-DIIN7FO0.css +0 -1
- package/templates/hono/dist/de/about/index.html +0 -32
- package/templates/hono/dist/de/guide/commands/index.html +0 -41
- package/templates/hono/dist/de/guide/configuration/index.html +0 -105
- package/templates/hono/dist/de/guide/deploy/index.html +0 -195
- package/templates/hono/dist/de/guide/first-five-minutes/index.html +0 -99
- package/templates/hono/dist/de/guide/getting-started/index.html +0 -173
- package/templates/hono/dist/de/guide/routing/index.html +0 -165
- package/templates/hono/dist/de/guide/seiten-erstellen/index.html +0 -234
- package/templates/hono/dist/de/guide/what-is-preactpress/index.html +0 -141
- package/templates/hono/dist/de/index.html +0 -30
- package/templates/hono/dist/de/interactive/index.html +0 -37
- package/templates/hono/dist/de/markdown-examples/index.html +0 -97
- package/templates/hono/dist/de/parts/include-body/index.html +0 -36
- package/templates/hono/dist/de/tags/markdown/index.html +0 -32
- package/templates/hono/dist/favicon-32.png +0 -0
- package/templates/hono/dist/favicon.png +0 -0
- package/templates/hono/dist/favicon.svg +0 -28
- package/templates/hono/dist/guide/commands/index.html +0 -41
- package/templates/hono/dist/guide/configuration/index.html +0 -158
- package/templates/hono/dist/guide/creating-pages/index.html +0 -234
- package/templates/hono/dist/guide/deploy/index.html +0 -195
- package/templates/hono/dist/guide/first-five-minutes/index.html +0 -99
- package/templates/hono/dist/guide/getting-started/index.html +0 -173
- package/templates/hono/dist/guide/routing/index.html +0 -165
- package/templates/hono/dist/guide/what-is-preactpress/index.html +0 -141
- package/templates/hono/dist/index.html +0 -30
- package/templates/hono/dist/interactive/index.html +0 -37
- package/templates/hono/dist/markdown-examples/index.html +0 -105
- package/templates/hono/dist/partials/shared-note/index.html +0 -30
- package/templates/hono/dist/parts/include-body/index.html +0 -36
- package/templates/hono/dist/preactpress-content/404.json +0 -8
- package/templates/hono/dist/preactpress-content/README.json +0 -26
- package/templates/hono/dist/preactpress-content/about.json +0 -15
- package/templates/hono/dist/preactpress-content/de__about.json +0 -15
- package/templates/hono/dist/preactpress-content/de__guide__commands.json +0 -36
- package/templates/hono/dist/preactpress-content/de__guide__configuration.json +0 -41
- package/templates/hono/dist/preactpress-content/de__guide__deploy.json +0 -56
- package/templates/hono/dist/preactpress-content/de__guide__first-five-minutes.json +0 -36
- package/templates/hono/dist/preactpress-content/de__guide__getting-started.json +0 -51
- package/templates/hono/dist/preactpress-content/de__guide__routing.json +0 -61
- package/templates/hono/dist/preactpress-content/de__guide__seiten-erstellen.json +0 -71
- package/templates/hono/dist/preactpress-content/de__guide__what-is-preactpress.json +0 -51
- package/templates/hono/dist/preactpress-content/de__markdown-examples.json +0 -131
- package/templates/hono/dist/preactpress-content/de__parts__include-body.json +0 -16
- package/templates/hono/dist/preactpress-content/de__tags__markdown.json +0 -16
- package/templates/hono/dist/preactpress-content/guide__commands.json +0 -36
- package/templates/hono/dist/preactpress-content/guide__configuration.json +0 -51
- package/templates/hono/dist/preactpress-content/guide__creating-pages.json +0 -71
- package/templates/hono/dist/preactpress-content/guide__deploy.json +0 -56
- package/templates/hono/dist/preactpress-content/guide__first-five-minutes.json +0 -36
- package/templates/hono/dist/preactpress-content/guide__getting-started.json +0 -51
- package/templates/hono/dist/preactpress-content/guide__routing.json +0 -61
- package/templates/hono/dist/preactpress-content/guide__what-is-preactpress.json +0 -51
- package/templates/hono/dist/preactpress-content/markdown-examples.json +0 -141
- package/templates/hono/dist/preactpress-content/partials__shared-note.json +0 -10
- package/templates/hono/dist/preactpress-content/parts__include-body.json +0 -16
- package/templates/hono/dist/preactpress-content/tags__markdown.json +0 -16
- package/templates/hono/dist/preactpress-search.json +0 -242
- package/templates/hono/dist/preactpress-theme.js +0 -1
- package/templates/hono/dist/tags/markdown/index.html +0 -32
|
@@ -36,18 +36,18 @@ Im separaten Projekt `preactpress-examples` gibt es ein Custom-Theme-Beispiel mi
|
|
|
36
36
|
|
|
37
37
|
PreactPress soll Content-Arbeit einfach halten:
|
|
38
38
|
|
|
39
|
-
| Feature
|
|
40
|
-
|
|
|
41
|
-
| Vite Dev-Server
|
|
39
|
+
| Feature | Nutzen |
|
|
40
|
+
| -------------------- | -------------------------------------------------------------- |
|
|
41
|
+
| Vite Dev-Server | Schneller Start und Hot Updates beim Bearbeiten |
|
|
42
42
|
| Markdown-Frontmatter | Titel, Beschreibungen, Tags, Draft-Status und Social-Metadaten |
|
|
43
|
-
| MDX
|
|
44
|
-
| Standard-Theme
|
|
45
|
-
| `preactpress check`
|
|
43
|
+
| MDX | Preact-Komponenten direkt in Inhaltsseiten |
|
|
44
|
+
| Standard-Theme | Nav, Sidebar, Outline, Suche, Footer, Sprachumschalter |
|
|
45
|
+
| `preactpress check` | Validierung von Config, Routen und Links vor dem Release |
|
|
46
46
|
|
|
47
47
|
Für normale Inhalte nimmst du `.md`. Wenn eine Seite Interaktivität braucht, nimmst du `.mdx` und importierst eine Preact-Komponente:
|
|
48
48
|
|
|
49
49
|
```mdx
|
|
50
|
-
import Counter from
|
|
50
|
+
import Counter from "./components/Counter.tsx";
|
|
51
51
|
|
|
52
52
|
## Demo
|
|
53
53
|
|
|
@@ -62,13 +62,13 @@ Nach der Hydration übernimmt die Client-Navigation. Markdown-Seiten werden als
|
|
|
62
62
|
|
|
63
63
|
Der Produktionsbuild besteht nur aus statischen Dateien:
|
|
64
64
|
|
|
65
|
-
| Ausgabe
|
|
66
|
-
|
|
|
67
|
-
| `index.html`, `*/index.html` | Eine HTML-Datei pro Route
|
|
68
|
-
| `assets/*`
|
|
69
|
-
| `preactpress-search.json`
|
|
70
|
-
| `preactpress-content/*.json` | Lazy geladene Markdown-Payloads
|
|
71
|
-
| `404.html`
|
|
65
|
+
| Ausgabe | Zweck |
|
|
66
|
+
| ---------------------------- | ------------------------------------- |
|
|
67
|
+
| `index.html`, `*/index.html` | Eine HTML-Datei pro Route |
|
|
68
|
+
| `assets/*` | Gehashtes JavaScript und CSS von Vite |
|
|
69
|
+
| `preactpress-search.json` | Suchdaten für das Standard-Theme |
|
|
70
|
+
| `preactpress-content/*.json` | Lazy geladene Markdown-Payloads |
|
|
71
|
+
| `404.html` | Fehlerseite |
|
|
72
72
|
|
|
73
73
|
## Was ist mit VitePress?
|
|
74
74
|
|
|
@@ -80,8 +80,8 @@ PreactPress ist in Produktion außerdem static-only. Du baust die Site einmal, l
|
|
|
80
80
|
|
|
81
81
|
## Nächste Schritte
|
|
82
82
|
|
|
83
|
-
| Seite
|
|
84
|
-
|
|
|
83
|
+
| Seite | Warum |
|
|
84
|
+
| -------------------------------------------- | ----------------------------------------------------------- |
|
|
85
85
|
| [Getting Started](/de/guide/getting-started) | PreactPress installieren und die Starter-Struktur verstehen |
|
|
86
|
-
| [Routing](/de/guide/routing)
|
|
87
|
-
| [Deploy](/de/guide/deploy)
|
|
86
|
+
| [Routing](/de/guide/routing) | Lernen, wie Dateien zu URLs werden |
|
|
87
|
+
| [Deploy](/de/guide/deploy) | Eine statische Site bauen und veröffentlichen |
|
|
@@ -3,8 +3,8 @@ title: Schnell, schlank, auf Web-Standards gebaut
|
|
|
3
3
|
description: Ein von hono.dev inspiriertes Starter-Template für Dokumentation und Produktseiten mit PreactPress.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import FeatureGrid from
|
|
7
|
-
import Hero from
|
|
6
|
+
import FeatureGrid from "../.preactpress/theme/FeatureGrid.tsx";
|
|
7
|
+
import Hero from "../.preactpress/theme/Hero.tsx";
|
|
8
8
|
|
|
9
9
|
<Hero
|
|
10
10
|
eyebrow="Hono-inspirierter Starter"
|
|
@@ -12,14 +12,14 @@ import Hero from '../.preactpress/theme/Hero.tsx'
|
|
|
12
12
|
subtitle="Nutze dieses Template für hochwertige Dokumentation, Beispiele und Produktseiten mit einem kompakten Preact-Theme."
|
|
13
13
|
actions={[
|
|
14
14
|
{ text: 'Loslegen', link: '/de/guide/getting-started', theme: 'brand' },
|
|
15
|
-
{ text: 'Auf GitHub ansehen', link: 'https://github.com/
|
|
15
|
+
{ text: 'Auf GitHub ansehen', link: 'https://github.com/kamod-ch/preactpress', theme: 'alt' }
|
|
16
16
|
]}
|
|
17
17
|
code={`import { App } from 'your-framework'
|
|
18
18
|
|
|
19
19
|
const app = new App()
|
|
20
20
|
|
|
21
21
|
app.get('/', (c) => {
|
|
22
|
-
|
|
22
|
+
return c.text('Hallo Web-Standards!')
|
|
23
23
|
})
|
|
24
24
|
|
|
25
25
|
export default app`}
|
|
@@ -28,24 +28,27 @@ export default app`}
|
|
|
28
28
|
<FeatureGrid
|
|
29
29
|
features={[
|
|
30
30
|
{
|
|
31
|
-
icon:
|
|
32
|
-
title:
|
|
33
|
-
details:
|
|
31
|
+
icon: "F",
|
|
32
|
+
title: "Ultraschnell & leichtgewichtig",
|
|
33
|
+
details: "Statisches HTML, wenig Client-Code und ein Theme, das deine Docs responsiv hält.",
|
|
34
34
|
},
|
|
35
35
|
{
|
|
36
|
-
icon:
|
|
37
|
-
title:
|
|
38
|
-
details:
|
|
36
|
+
icon: "R",
|
|
37
|
+
title: "Für viele Runtimes gedacht",
|
|
38
|
+
details:
|
|
39
|
+
"Schreibe portable Beispiele für Node, Bun, Deno, Edge Workers und statisches Hosting.",
|
|
39
40
|
},
|
|
40
41
|
{
|
|
41
|
-
icon:
|
|
42
|
-
title:
|
|
43
|
-
details:
|
|
42
|
+
icon: "B",
|
|
43
|
+
title: "Batterien inklusive",
|
|
44
|
+
details:
|
|
45
|
+
"Navigation, Sidebar-Suche, MDX, Tags, i18n und statische Builds sind direkt startklar.",
|
|
44
46
|
},
|
|
45
47
|
{
|
|
46
|
-
icon:
|
|
47
|
-
title:
|
|
48
|
-
details:
|
|
49
|
-
|
|
48
|
+
icon: "D",
|
|
49
|
+
title: "Angenehme DX",
|
|
50
|
+
details:
|
|
51
|
+
"Markdown-first Content, Vite-Geschwindigkeit und editierbare Preact-Komponenten für Custom Pages.",
|
|
52
|
+
},
|
|
50
53
|
]}
|
|
51
54
|
/>
|
|
@@ -17,7 +17,7 @@ Einzelne Zeilen kannst du per Fence-Meta (`{2}`) oder Inline-Notation markieren:
|
|
|
17
17
|
|
|
18
18
|
```ts
|
|
19
19
|
export function greet(name: string) {
|
|
20
|
-
return `Hallo, ${name}
|
|
20
|
+
return `Hallo, ${name}!`; // [!code highlight]
|
|
21
21
|
}
|
|
22
22
|
```
|
|
23
23
|
|
|
@@ -37,9 +37,9 @@ Das `@/`-Präfix wird relativ zum Content-Root (`srcDir`) aufgelöst.
|
|
|
37
37
|
|
|
38
38
|
## Tabellen
|
|
39
39
|
|
|
40
|
-
| Syntax
|
|
41
|
-
|
|
|
42
|
-
| `# Titel`
|
|
40
|
+
| Syntax | Ergebnis |
|
|
41
|
+
| ----------------- | --------------- |
|
|
42
|
+
| `# Titel` | Überschrift |
|
|
43
43
|
| `---` Frontmatter | Seitenmetadaten |
|
|
44
44
|
|
|
45
45
|
## Zitate
|
|
@@ -128,11 +128,11 @@ Verschachtelte Überschrift für die Gliederung.
|
|
|
128
128
|
::: code-group
|
|
129
129
|
|
|
130
130
|
```js [config.js]
|
|
131
|
-
export default { lang:
|
|
131
|
+
export default { lang: "js" };
|
|
132
132
|
```
|
|
133
133
|
|
|
134
134
|
```ts [config.ts]
|
|
135
|
-
export default { lang:
|
|
135
|
+
export default { lang: "ts" };
|
|
136
136
|
```
|
|
137
137
|
|
|
138
138
|
:::
|
|
@@ -10,23 +10,23 @@ Configuration lives in `.preactpress/config.ts` at your site root.
|
|
|
10
10
|
```ts
|
|
11
11
|
export default {
|
|
12
12
|
site: {
|
|
13
|
-
title:
|
|
14
|
-
description:
|
|
15
|
-
base:
|
|
16
|
-
url:
|
|
17
|
-
titleTemplate:
|
|
18
|
-
}
|
|
19
|
-
}
|
|
13
|
+
title: "My docs",
|
|
14
|
+
description: "Short site summary for SEO",
|
|
15
|
+
base: "/",
|
|
16
|
+
url: "https://example.com",
|
|
17
|
+
titleTemplate: ":title | :siteTitle",
|
|
18
|
+
},
|
|
19
|
+
};
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
Set `site.url` before production so canonical URLs, `sitemap.xml`, Open Graph, and `hreflang` alternates resolve correctly.
|
|
23
23
|
|
|
24
24
|
## Content directory
|
|
25
25
|
|
|
26
|
-
| Option
|
|
27
|
-
|
|
|
28
|
-
| `srcDir`
|
|
29
|
-
| `srcExclude`
|
|
26
|
+
| Option | Purpose |
|
|
27
|
+
| ---------------- | ----------------------------------------------------------------- |
|
|
28
|
+
| `srcDir` | Folder with `.md` / `.mdx` pages (default `.`) |
|
|
29
|
+
| `srcExclude` | Glob patterns for non-page Markdown, e.g. `['**/README.md']` |
|
|
30
30
|
| `lastUpdatedGit` | Use git commit time for “last updated” (falls back to file mtime) |
|
|
31
31
|
|
|
32
32
|
## Theme without custom code
|
|
@@ -96,9 +96,9 @@ themeConfig: {
|
|
|
96
96
|
```ts
|
|
97
97
|
themeConfig: {
|
|
98
98
|
socialLinks: [
|
|
99
|
-
{ icon:
|
|
100
|
-
{ icon: { svg:
|
|
101
|
-
]
|
|
99
|
+
{ icon: "github", link: "https://github.com/kamod-ch/preactpress" },
|
|
100
|
+
{ icon: { svg: "<svg ...></svg>" }, link: "https://example.com", ariaLabel: "Company site" },
|
|
101
|
+
];
|
|
102
102
|
}
|
|
103
103
|
```
|
|
104
104
|
|
|
@@ -140,25 +140,25 @@ async buildEnd({ site, pages }) {
|
|
|
140
140
|
Export a factory to load nav or sidebar from an API at config time:
|
|
141
141
|
|
|
142
142
|
```ts
|
|
143
|
-
import { defineConfig } from
|
|
143
|
+
import { defineConfig } from "@kamod-ch/preactpress/config";
|
|
144
144
|
|
|
145
145
|
export default defineConfig(async () => ({
|
|
146
|
-
site: { title:
|
|
146
|
+
site: { title: "My docs", description: "Docs from CMS" },
|
|
147
147
|
themeConfig: {
|
|
148
148
|
nav: await fetchNav(),
|
|
149
|
-
sidebar: await fetchSidebar()
|
|
150
|
-
}
|
|
151
|
-
}))
|
|
149
|
+
sidebar: await fetchSidebar(),
|
|
150
|
+
},
|
|
151
|
+
}));
|
|
152
152
|
```
|
|
153
153
|
|
|
154
154
|
## Page frontmatter
|
|
155
155
|
|
|
156
|
-
| Field
|
|
157
|
-
|
|
|
158
|
-
| `title` / `description` | Page title and SEO summary
|
|
159
|
-
| `titleTemplate`
|
|
160
|
-
| `head`
|
|
161
|
-
| `draft: true`
|
|
156
|
+
| Field | Purpose |
|
|
157
|
+
| ----------------------- | -------------------------------------------------------------- |
|
|
158
|
+
| `title` / `description` | Page title and SEO summary |
|
|
159
|
+
| `titleTemplate` | Override site template; `false` uses the raw page title |
|
|
160
|
+
| `head` | Extra `<meta>` / `<link>` / `<script>` tags for this page only |
|
|
161
|
+
| `draft: true` | Excluded from routes, search, and sitemap |
|
|
162
162
|
|
|
163
163
|
Example per-page head:
|
|
164
164
|
|
|
@@ -40,14 +40,14 @@ Save the file — with `pnpm run dev` running, the page is immediately available
|
|
|
40
40
|
|
|
41
41
|
PreactPress uses **file-based routing**. The path relative to `srcDir` becomes the route:
|
|
42
42
|
|
|
43
|
-
| File
|
|
44
|
-
|
|
|
45
|
-
| `index.md`
|
|
46
|
-
| `about.md`
|
|
47
|
-
| `guide/intro.md`
|
|
48
|
-
| `guide/index.md`
|
|
43
|
+
| File | URL |
|
|
44
|
+
| -------------------- | ------------------ |
|
|
45
|
+
| `index.md` | `/` |
|
|
46
|
+
| `about.md` | `/about` |
|
|
47
|
+
| `guide/intro.md` | `/guide/intro` |
|
|
48
|
+
| `guide/index.md` | `/guide` |
|
|
49
49
|
| `news/2025/intro.md` | `/news/2025/intro` |
|
|
50
|
-
| `interactive.mdx`
|
|
50
|
+
| `interactive.mdx` | `/interactive` |
|
|
51
51
|
|
|
52
52
|
Production builds write directory indexes (`dist/about/index.html`) so URLs work without `.html`.
|
|
53
53
|
|
|
@@ -60,8 +60,8 @@ By default, Markdown files live in the project root next to `.preactpress/`. You
|
|
|
60
60
|
```ts
|
|
61
61
|
// .preactpress/config.ts
|
|
62
62
|
export default {
|
|
63
|
-
srcDir:
|
|
64
|
-
}
|
|
63
|
+
srcDir: "docs",
|
|
64
|
+
};
|
|
65
65
|
```
|
|
66
66
|
|
|
67
67
|
Then all pages live under `docs/` — e.g. `docs/index.md` → `/`, `docs/guide/foo.md` → `/guide/foo`. URLs stay the same; only the file location changes.
|
|
@@ -78,14 +78,14 @@ layout: doc
|
|
|
78
78
|
---
|
|
79
79
|
```
|
|
80
80
|
|
|
81
|
-
| Field
|
|
82
|
-
|
|
|
83
|
-
| `title`
|
|
84
|
-
| `description`
|
|
85
|
-
| `layout: doc`
|
|
86
|
-
| `layout: page` | Content page without sidebar or doc outline
|
|
87
|
-
| `layout: home` | Home layout with optional `hero` and `features`
|
|
88
|
-
| `draft: true`
|
|
81
|
+
| Field | Purpose |
|
|
82
|
+
| -------------- | ---------------------------------------------------------- |
|
|
83
|
+
| `title` | Page title (nav, `<title>`, search) |
|
|
84
|
+
| `description` | Summary for SEO and search |
|
|
85
|
+
| `layout: doc` | Docs layout with sidebar, outline, and previous/next links |
|
|
86
|
+
| `layout: page` | Content page without sidebar or doc outline |
|
|
87
|
+
| `layout: home` | Home layout with optional `hero` and `features` |
|
|
88
|
+
| `draft: true` | Excluded from build, sitemap, and search |
|
|
89
89
|
|
|
90
90
|
Additional fields (`tags`, `sidebar: false`, `navbar: false`, …) are documented in the package README and starter reference.
|
|
91
91
|
|
|
@@ -99,7 +99,7 @@ title: Demo
|
|
|
99
99
|
description: Interactive component
|
|
100
100
|
---
|
|
101
101
|
|
|
102
|
-
import Counter from
|
|
102
|
+
import Counter from "./components/Counter.tsx";
|
|
103
103
|
|
|
104
104
|
## Counter
|
|
105
105
|
|
|
@@ -118,20 +118,20 @@ New pages do **not** appear in the header or sidebar automatically. Register the
|
|
|
118
118
|
export default {
|
|
119
119
|
themeConfig: {
|
|
120
120
|
nav: [
|
|
121
|
-
{ text:
|
|
122
|
-
{ text:
|
|
121
|
+
{ text: "Home", link: "/" },
|
|
122
|
+
{ text: "Contact", link: "/contact" },
|
|
123
123
|
],
|
|
124
124
|
sidebar: [
|
|
125
125
|
{
|
|
126
|
-
text:
|
|
126
|
+
text: "Guide",
|
|
127
127
|
items: [
|
|
128
|
-
{ text:
|
|
129
|
-
{ text:
|
|
130
|
-
]
|
|
131
|
-
}
|
|
132
|
-
]
|
|
133
|
-
}
|
|
134
|
-
}
|
|
128
|
+
{ text: "Creating pages", link: "/guide/creating-pages" },
|
|
129
|
+
{ text: "Contact", link: "/contact" },
|
|
130
|
+
],
|
|
131
|
+
},
|
|
132
|
+
],
|
|
133
|
+
},
|
|
134
|
+
};
|
|
135
135
|
```
|
|
136
136
|
|
|
137
137
|
For multilingual sites (`locales`), put `nav` and `sidebar` in each locale block — see [Getting Started](/guide/getting-started).
|
|
@@ -154,18 +154,18 @@ Each locale is a **separate file**, not an alias of the default page.
|
|
|
154
154
|
|
|
155
155
|
## Common issues
|
|
156
156
|
|
|
157
|
-
| Problem
|
|
158
|
-
|
|
|
159
|
-
| Page returns 404
|
|
160
|
-
| Markdown link broken
|
|
161
|
-
| Duplicate URL
|
|
162
|
-
| Page missing from nav | Add to `nav` / `sidebar` in config
|
|
157
|
+
| Problem | Fix |
|
|
158
|
+
| --------------------- | --------------------------------------------------------------------------- |
|
|
159
|
+
| Page returns 404 | `.md` / `.mdx` extension? File under `srcDir`? Dev server running? |
|
|
160
|
+
| Markdown link broken | Omit extension: `/guide/foo`, not `/guide/foo.md` |
|
|
161
|
+
| Duplicate URL | Two files must not map to the same route (e.g. `foo.md` and `foo/index.md`) |
|
|
162
|
+
| Page missing from nav | Add to `nav` / `sidebar` in config |
|
|
163
163
|
|
|
164
164
|
## Next steps
|
|
165
165
|
|
|
166
|
-
| Topic
|
|
167
|
-
|
|
|
166
|
+
| Topic | Link |
|
|
167
|
+
| -------------------------- | ------------------------------------------------- |
|
|
168
168
|
| First changes in 5 minutes | [Your first 5 minutes](/guide/first-five-minutes) |
|
|
169
|
-
| Routing, `srcDir`, tags
|
|
170
|
-
| Markdown syntax
|
|
171
|
-
| Production build
|
|
169
|
+
| Routing, `srcDir`, tags | [Routing](/guide/routing) |
|
|
170
|
+
| Markdown syntax | [Markdown examples](/markdown-examples) |
|
|
171
|
+
| Production build | [Deploy](/guide/deploy) |
|
|
@@ -33,16 +33,16 @@ Set `site.url` before publishing. PreactPress uses it for canonical URLs, Open G
|
|
|
33
33
|
```ts
|
|
34
34
|
export default {
|
|
35
35
|
site: {
|
|
36
|
-
title:
|
|
37
|
-
description:
|
|
38
|
-
url:
|
|
39
|
-
base:
|
|
36
|
+
title: "My site",
|
|
37
|
+
description: "Short summary for search and social previews",
|
|
38
|
+
url: "https://example.com",
|
|
39
|
+
base: "/",
|
|
40
40
|
},
|
|
41
41
|
build: {
|
|
42
42
|
sitemap: true,
|
|
43
|
-
robots: true
|
|
44
|
-
}
|
|
45
|
-
}
|
|
43
|
+
robots: true,
|
|
44
|
+
},
|
|
45
|
+
};
|
|
46
46
|
```
|
|
47
47
|
|
|
48
48
|
## Public base path
|
|
@@ -58,10 +58,10 @@ If the site is served from a subpath, set `site.base`:
|
|
|
58
58
|
```ts
|
|
59
59
|
export default {
|
|
60
60
|
site: {
|
|
61
|
-
url:
|
|
62
|
-
base:
|
|
63
|
-
}
|
|
64
|
-
}
|
|
61
|
+
url: "https://user.github.io",
|
|
62
|
+
base: "/my-repo/",
|
|
63
|
+
},
|
|
64
|
+
};
|
|
65
65
|
```
|
|
66
66
|
|
|
67
67
|
You can also override the base path for a single build:
|
|
@@ -74,15 +74,15 @@ pnpm exec preactpress build --base /my-repo/
|
|
|
74
74
|
|
|
75
75
|
The default output directory is `dist/`:
|
|
76
76
|
|
|
77
|
-
| Output
|
|
78
|
-
|
|
|
79
|
-
| `index.html`, `*/index.html` | Static HTML for each route
|
|
80
|
-
| `assets/*`
|
|
81
|
-
| `404.html`
|
|
82
|
-
| `preactpress-search.json`
|
|
77
|
+
| Output | Description |
|
|
78
|
+
| ---------------------------- | --------------------------------------------------- |
|
|
79
|
+
| `index.html`, `*/index.html` | Static HTML for each route |
|
|
80
|
+
| `assets/*` | Hashed JavaScript and CSS from Vite |
|
|
81
|
+
| `404.html` | Not-found page |
|
|
82
|
+
| `preactpress-search.json` | Search index for the default theme |
|
|
83
83
|
| `preactpress-content/*.json` | Lazy-loaded Markdown payloads for client navigation |
|
|
84
|
-
| `sitemap.xml`, `robots.txt`
|
|
85
|
-
| `feed.xml`
|
|
84
|
+
| `sitemap.xml`, `robots.txt` | Generated when `site.url` and build flags are set |
|
|
85
|
+
| `feed.xml` | Generated when `build.feed` is configured |
|
|
86
86
|
|
|
87
87
|
Deploy only the output directory. Do not deploy `node_modules`, `.preactpress`, or the build cache.
|
|
88
88
|
|
|
@@ -90,12 +90,12 @@ Deploy only the output directory. Do not deploy `node_modules`, `.preactpress`,
|
|
|
90
90
|
|
|
91
91
|
For most static hosts, use these settings:
|
|
92
92
|
|
|
93
|
-
| Host
|
|
94
|
-
|
|
|
95
|
-
| Netlify
|
|
96
|
-
| Vercel
|
|
97
|
-
| Cloudflare Pages
|
|
98
|
-
| Render Static Site | `pnpm run build` | `dist`
|
|
93
|
+
| Host | Build command | Output directory |
|
|
94
|
+
| ------------------ | ---------------- | ---------------- |
|
|
95
|
+
| Netlify | `pnpm run build` | `dist` |
|
|
96
|
+
| Vercel | `pnpm run build` | `dist` |
|
|
97
|
+
| Cloudflare Pages | `pnpm run build` | `dist` |
|
|
98
|
+
| Render Static Site | `pnpm run build` | `dist` |
|
|
99
99
|
|
|
100
100
|
Install command:
|
|
101
101
|
|
|
@@ -112,10 +112,10 @@ For a project site at `https://user.github.io/my-repo/`, configure:
|
|
|
112
112
|
```ts
|
|
113
113
|
export default {
|
|
114
114
|
site: {
|
|
115
|
-
url:
|
|
116
|
-
base:
|
|
117
|
-
}
|
|
118
|
-
}
|
|
115
|
+
url: "https://user.github.io",
|
|
116
|
+
base: "/my-repo/",
|
|
117
|
+
},
|
|
118
|
+
};
|
|
119
119
|
```
|
|
120
120
|
|
|
121
121
|
Then deploy the `dist/` directory.
|
|
@@ -14,10 +14,10 @@ Edit `.preactpress/config.ts`:
|
|
|
14
14
|
```ts
|
|
15
15
|
export default {
|
|
16
16
|
site: {
|
|
17
|
-
title:
|
|
18
|
-
description:
|
|
19
|
-
}
|
|
20
|
-
}
|
|
17
|
+
title: "My Docs",
|
|
18
|
+
description: "Short summary for search and social previews",
|
|
19
|
+
},
|
|
20
|
+
};
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
Save the file. The dev server picks up config changes on the next request.
|
|
@@ -49,34 +49,34 @@ In `.preactpress/config.ts`:
|
|
|
49
49
|
|
|
50
50
|
```ts
|
|
51
51
|
export default {
|
|
52
|
-
site: { title:
|
|
52
|
+
site: { title: "My Docs" },
|
|
53
53
|
themeConfig: {
|
|
54
54
|
nav: [
|
|
55
|
-
{ text:
|
|
56
|
-
{ text:
|
|
55
|
+
{ text: "Home", link: "/" },
|
|
56
|
+
{ text: "About", link: "/about" },
|
|
57
57
|
],
|
|
58
58
|
sidebar: [
|
|
59
59
|
{
|
|
60
|
-
text:
|
|
60
|
+
text: "Guide",
|
|
61
61
|
items: [
|
|
62
|
-
{ text:
|
|
63
|
-
{ text:
|
|
64
|
-
]
|
|
65
|
-
}
|
|
66
|
-
]
|
|
67
|
-
}
|
|
68
|
-
}
|
|
62
|
+
{ text: "Home", link: "/" },
|
|
63
|
+
{ text: "About", link: "/about" },
|
|
64
|
+
],
|
|
65
|
+
},
|
|
66
|
+
],
|
|
67
|
+
},
|
|
68
|
+
};
|
|
69
69
|
```
|
|
70
70
|
|
|
71
71
|
Save — the dev server hot-reloads your changes.
|
|
72
72
|
|
|
73
73
|
## Next steps
|
|
74
74
|
|
|
75
|
-
| Command
|
|
76
|
-
|
|
|
77
|
-
| `pnpm run dev`
|
|
78
|
-
| `pnpm run check`
|
|
79
|
-
| `pnpm run build`
|
|
80
|
-
| `pnpm run preview` | Local preview of the build
|
|
75
|
+
| Command | Purpose |
|
|
76
|
+
| ------------------ | ---------------------------------- |
|
|
77
|
+
| `pnpm run dev` | Dev server with SSR and hot reload |
|
|
78
|
+
| `pnpm run check` | Validate config, links, and routes |
|
|
79
|
+
| `pnpm run build` | Static production build → `dist/` |
|
|
80
|
+
| `pnpm run preview` | Local preview of the build |
|
|
81
81
|
|
|
82
82
|
Before deploying, set `site.url` in config for canonical URLs, Open Graph tags, and `sitemap.xml`. Continue with [Routing](/guide/routing) to understand file-based routes, then [Deploy](/guide/deploy) for production build steps.
|