@wrikka/create-docs 0.1.0
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 +137 -0
- package/bin/cli.js +408 -0
- package/dist/index.cjs +20 -0
- package/dist/index.d.cts +475 -0
- package/dist/index.d.ts +475 -0
- package/dist/index.js +20 -0
- package/docs/_dir.yml +2 -0
- package/docs/config.md +75 -0
- package/docs/data-sources.md +88 -0
- package/docs/deploy.md +38 -0
- package/docs/features.md +51 -0
- package/docs/getting-started.md +42 -0
- package/docs/index.md +34 -0
- package/docs/markdown.md +154 -0
- package/docs/theming.md +53 -0
- package/package.json +142 -0
- package/scripts/generate-docs-index.ts +111 -0
- package/scripts/github-pull.ts +124 -0
- package/src/adapters/config/index.ts +1 -0
- package/src/adapters/config/node-config-loader.ts +36 -0
- package/src/adapters/fs/fs-docs-loader.ts +31 -0
- package/src/adapters/fs/index.ts +12 -0
- package/src/adapters/fs/memory-fs.ts +60 -0
- package/src/adapters/fs/node-fs.ts +116 -0
- package/src/adapters/git/index.ts +164 -0
- package/src/adapters/github/github-pull.ts +340 -0
- package/src/adapters/index.ts +6 -0
- package/src/adapters/velite.ts +112 -0
- package/src/adapters/vite/docs-watcher.ts +36 -0
- package/src/adapters/vite/index.ts +2 -0
- package/src/adapters/vite/polling-watcher.ts +89 -0
- package/src/code-block-enhancements/index.ts +3 -0
- package/src/config/index.ts +15 -0
- package/src/content/index.ts +11 -0
- package/src/content-validation/index.ts +5 -0
- package/src/index.ts +174 -0
- package/src/live-editor/index.ts +7 -0
- package/src/modules/analytics/application/plausible-adapter.ts +103 -0
- package/src/modules/analytics/application/umami-adapter.ts +109 -0
- package/src/modules/analytics/domain/events/index.ts +37 -0
- package/src/modules/analytics/domain/models/index.ts +35 -0
- package/src/modules/analytics/domain/operations/analytics-operations.ts +67 -0
- package/src/modules/analytics/domain/validators/index.ts +50 -0
- package/src/modules/analytics/index.ts +9 -0
- package/src/modules/analytics/ports/analytics-port.ts +17 -0
- package/src/modules/analytics/types/analytics.ts +16 -0
- package/src/modules/api-docs/application/type-docs-adapter.ts +34 -0
- package/src/modules/api-docs/domain/events/index.ts +42 -0
- package/src/modules/api-docs/domain/models/index.ts +40 -0
- package/src/modules/api-docs/domain/operations/api-docs-operations.ts +59 -0
- package/src/modules/api-docs/domain/validators/index.ts +56 -0
- package/src/modules/api-docs/index.ts +8 -0
- package/src/modules/api-docs/ports/api-docs-port.ts +21 -0
- package/src/modules/api-docs/types/api-docs.ts +15 -0
- package/src/modules/api-reference/openapi.ts +166 -0
- package/src/modules/api-reference/orpc.ts +94 -0
- package/src/modules/code-block-enhancements/application/usecases/index.ts +39 -0
- package/src/modules/code-block-enhancements/domain/code-operations.ts +72 -0
- package/src/modules/code-block-enhancements/domain/events/index.ts +58 -0
- package/src/modules/code-block-enhancements/domain/index.ts +11 -0
- package/src/modules/code-block-enhancements/domain/models/index.ts +36 -0
- package/src/modules/code-block-enhancements/domain/validators/index.ts +50 -0
- package/src/modules/code-block-enhancements/index.ts +10 -0
- package/src/modules/code-block-enhancements/ports/index.ts +18 -0
- package/src/modules/code-block-enhancements/types/index.ts +37 -0
- package/src/modules/code-execution/application/sandbox-adapter.ts +44 -0
- package/src/modules/code-execution/domain/events/index.ts +58 -0
- package/src/modules/code-execution/domain/models/index.ts +33 -0
- package/src/modules/code-execution/domain/operations/execution-operations.ts +60 -0
- package/src/modules/code-execution/domain/validators/index.ts +50 -0
- package/src/modules/code-execution/index.ts +8 -0
- package/src/modules/code-execution/ports/execution-port.ts +15 -0
- package/src/modules/code-execution/types/execution.ts +15 -0
- package/src/modules/comments/application/giscus-adapter.ts +55 -0
- package/src/modules/comments/domain/events/index.ts +55 -0
- package/src/modules/comments/domain/models/index.ts +30 -0
- package/src/modules/comments/domain/operations/comment-operations.ts +46 -0
- package/src/modules/comments/domain/validators/index.ts +50 -0
- package/src/modules/comments/index.ts +8 -0
- package/src/modules/comments/ports/comment-port.ts +18 -0
- package/src/modules/comments/types/comments.ts +19 -0
- package/src/modules/config/application/usecases/index.ts +1 -0
- package/src/modules/config/application/usecases/loadConfig.ts +38 -0
- package/src/modules/config/application/workflows/index.ts +1 -0
- package/src/modules/config/application/workflows/validateConfig.ts +14 -0
- package/src/modules/config/domain/events/index.ts +50 -0
- package/src/modules/config/domain/models/index.ts +9 -0
- package/src/modules/config/domain/operations/defaults.ts +74 -0
- package/src/modules/config/domain/operations/index.ts +2 -0
- package/src/modules/config/domain/operations/resolve.ts +40 -0
- package/src/modules/config/domain/validators/index.ts +152 -0
- package/src/modules/config/index.ts +23 -0
- package/src/modules/config/ports/index.ts +15 -0
- package/src/modules/config/types/index.ts +113 -0
- package/src/modules/config/types/public.ts +19 -0
- package/src/modules/content/application/cache/index.ts +6 -0
- package/src/modules/content/application/cache/parse-cache.ts +6 -0
- package/src/modules/content/application/cache/parseCache.ts +56 -0
- package/src/modules/content/application/usecases/index.ts +2 -0
- package/src/modules/content/application/usecases/load-doc-page.ts +1 -0
- package/src/modules/content/application/usecases/loadDocPage.ts +111 -0
- package/src/modules/content/application/usecases/scanDocsDir.ts +105 -0
- package/src/modules/content/application/workflows/index.ts +1 -0
- package/src/modules/content/application/workflows/processDocs.ts +51 -0
- package/src/modules/content/domain/events/index.ts +61 -0
- package/src/modules/content/domain/models/index.ts +13 -0
- package/src/modules/content/domain/operations/build-page.ts +146 -0
- package/src/modules/content/domain/operations/buildPage.ts +93 -0
- package/src/modules/content/domain/operations/index.ts +17 -0
- package/src/modules/content/domain/operations/parse.ts +241 -0
- package/src/modules/content/domain/validators/frontmatter.ts +82 -0
- package/src/modules/content/domain/validators/index.ts +6 -0
- package/src/modules/content/index.ts +27 -0
- package/src/modules/content/ports/index.ts +45 -0
- package/src/modules/content/ports/velite.ts +134 -0
- package/src/modules/content/types/index.ts +76 -0
- package/src/modules/content/types/public.ts +1 -0
- package/src/modules/content-linting/application/builtin-linting-adapter.ts +82 -0
- package/src/modules/content-linting/domain/events/index.ts +58 -0
- package/src/modules/content-linting/domain/models/index.ts +46 -0
- package/src/modules/content-linting/domain/operations/linting-operations.ts +82 -0
- package/src/modules/content-linting/domain/validators/index.ts +50 -0
- package/src/modules/content-linting/index.ts +8 -0
- package/src/modules/content-linting/ports/linting-port.ts +21 -0
- package/src/modules/content-linting/types/linting.ts +18 -0
- package/src/modules/content-validation/application/usecases/index.ts +18 -0
- package/src/modules/content-validation/domain/events/index.ts +7 -0
- package/src/modules/content-validation/domain/index.ts +16 -0
- package/src/modules/content-validation/domain/models/index.ts +33 -0
- package/src/modules/content-validation/domain/operations/index.ts +157 -0
- package/src/modules/content-validation/domain/types/index.ts +17 -0
- package/src/modules/content-validation/domain/validators/index.ts +8 -0
- package/src/modules/content-validation/index.ts +9 -0
- package/src/modules/content-validation/ports/index.ts +15 -0
- package/src/modules/content-validation/types/index.ts +5 -0
- package/src/modules/export/application/puppeteer-export-adapter.ts +63 -0
- package/src/modules/export/domain/events/index.ts +55 -0
- package/src/modules/export/domain/models/index.ts +38 -0
- package/src/modules/export/domain/operations/export-operations.ts +56 -0
- package/src/modules/export/domain/validators/index.ts +52 -0
- package/src/modules/export/index.ts +8 -0
- package/src/modules/export/ports/export-port.ts +15 -0
- package/src/modules/export/types/export.ts +15 -0
- package/src/modules/external-search/application/algolia-adapter.ts +182 -0
- package/src/modules/external-search/application/meilisearch-adapter.ts +161 -0
- package/src/modules/external-search/domain/events/index.ts +42 -0
- package/src/modules/external-search/domain/models/index.ts +42 -0
- package/src/modules/external-search/domain/operations/search-operations.ts +53 -0
- package/src/modules/external-search/domain/validators/index.ts +55 -0
- package/src/modules/external-search/index.ts +9 -0
- package/src/modules/external-search/ports/external-search-port.ts +23 -0
- package/src/modules/external-search/types/search.ts +19 -0
- package/src/modules/git-history/application/simple-git-adapter.ts +46 -0
- package/src/modules/git-history/domain/events/index.ts +34 -0
- package/src/modules/git-history/domain/models/index.ts +25 -0
- package/src/modules/git-history/domain/operations/git-history-operations.ts +56 -0
- package/src/modules/git-history/domain/validators/index.ts +52 -0
- package/src/modules/git-history/index.ts +8 -0
- package/src/modules/git-history/ports/git-history-port.ts +21 -0
- package/src/modules/git-history/types/git-history.ts +15 -0
- package/src/modules/i18n/application/fs-locale-loader.ts +39 -0
- package/src/modules/i18n/domain/events/index.ts +34 -0
- package/src/modules/i18n/domain/models/index.ts +34 -0
- package/src/modules/i18n/domain/operations/locale-operations.ts +74 -0
- package/src/modules/i18n/domain/validators/index.ts +52 -0
- package/src/modules/i18n/index.ts +8 -0
- package/src/modules/i18n/ports/locale-loader-port.ts +18 -0
- package/src/modules/i18n/types/locale.ts +17 -0
- package/src/modules/image-optimization/application/sharp-adapter.ts +58 -0
- package/src/modules/image-optimization/domain/events/index.ts +39 -0
- package/src/modules/image-optimization/domain/models/index.ts +27 -0
- package/src/modules/image-optimization/domain/operations/image-operations.ts +65 -0
- package/src/modules/image-optimization/domain/validators/index.ts +52 -0
- package/src/modules/image-optimization/index.ts +8 -0
- package/src/modules/image-optimization/ports/image-optimizer-port.ts +15 -0
- package/src/modules/image-optimization/types/image.ts +17 -0
- package/src/modules/live-editor/application/usecases/index.ts +60 -0
- package/src/modules/live-editor/domain/events/index.ts +37 -0
- package/src/modules/live-editor/domain/gitOperations.ts +110 -0
- package/src/modules/live-editor/domain/index.ts +15 -0
- package/src/modules/live-editor/domain/models/index.ts +21 -0
- package/src/modules/live-editor/domain/validators/index.ts +55 -0
- package/src/modules/live-editor/index.ts +14 -0
- package/src/modules/live-editor/ports/index.ts +49 -0
- package/src/modules/live-editor/types/index.ts +80 -0
- package/src/modules/live-preview/application/vite-preview-adapter.ts +20 -0
- package/src/modules/live-preview/domain/operations/preview-operations.ts +56 -0
- package/src/modules/live-preview/index.ts +8 -0
- package/src/modules/live-preview/ports/preview-port.ts +20 -0
- package/src/modules/live-preview/types/preview.ts +16 -0
- package/src/modules/mdx/application/mdx-js-adapter.ts +38 -0
- package/src/modules/mdx/domain/operations/parse-mdx.ts +43 -0
- package/src/modules/mdx/index.ts +8 -0
- package/src/modules/mdx/ports/mdx-parser-port.ts +15 -0
- package/src/modules/mdx/types/mdx.ts +14 -0
- package/src/modules/navigation/application/usecases/buildNav.ts +15 -0
- package/src/modules/navigation/application/usecases/buildSidebar.ts +45 -0
- package/src/modules/navigation/application/usecases/index.ts +2 -0
- package/src/modules/navigation/domain/events/index.ts +30 -0
- package/src/modules/navigation/domain/models/index.ts +7 -0
- package/src/modules/navigation/domain/operations/group.ts +79 -0
- package/src/modules/navigation/domain/operations/index.ts +10 -0
- package/src/modules/navigation/domain/operations/sort.ts +27 -0
- package/src/modules/navigation/domain/shared/utils/array.ts +39 -0
- package/src/modules/navigation/domain/validators/index.ts +88 -0
- package/src/modules/navigation/index.ts +15 -0
- package/src/modules/navigation/ports/index.ts +9 -0
- package/src/modules/navigation/types/index.ts +38 -0
- package/src/modules/navigation/types/public.ts +9 -0
- package/src/modules/openapi/application/swagger-parser-adapter.ts +178 -0
- package/src/modules/openapi/domain/operations/parse-openapi.ts +46 -0
- package/src/modules/openapi/index.ts +8 -0
- package/src/modules/openapi/ports/openapi-parser-port.ts +15 -0
- package/src/modules/openapi/types/openapi.ts +37 -0
- package/src/modules/plugin/application/usecases/build-virtual-modules.ts +53 -0
- package/src/modules/plugin/application/usecases/index.ts +1 -0
- package/src/modules/plugin/application/workflows/build-docs.ts +79 -0
- package/src/modules/plugin/application/workflows/index.ts +1 -0
- package/src/modules/plugin/domain/events/index.ts +62 -0
- package/src/modules/plugin/domain/models/index.ts +1 -0
- package/src/modules/plugin/domain/operations/build-virtual.ts +76 -0
- package/src/modules/plugin/domain/operations/index.ts +11 -0
- package/src/modules/plugin/domain/validators/index.ts +30 -0
- package/src/modules/plugin/index.ts +14 -0
- package/src/modules/plugin/ports/index.ts +21 -0
- package/src/modules/plugin/types/index.ts +27 -0
- package/src/modules/plugin/types/public.ts +1 -0
- package/src/modules/search/application/usecases/index.ts +1 -0
- package/src/modules/search/application/usecases/indexPages.ts +15 -0
- package/src/modules/search/domain/events/index.ts +32 -0
- package/src/modules/search/domain/models/index.ts +1 -0
- package/src/modules/search/domain/operations/build-index.ts +6 -0
- package/src/modules/search/domain/operations/buildIndex.ts +70 -0
- package/src/modules/search/domain/operations/index.ts +7 -0
- package/src/modules/search/domain/operations/query.ts +186 -0
- package/src/modules/search/domain/validators/index.ts +32 -0
- package/src/modules/search/index.ts +9 -0
- package/src/modules/search/types/index.ts +22 -0
- package/src/modules/search/types/public.ts +1 -0
- package/src/modules/search-analytics/application/local-storage-adapter.ts +68 -0
- package/src/modules/search-analytics/domain/operations/search-analytics-operations.ts +74 -0
- package/src/modules/search-analytics/index.ts +8 -0
- package/src/modules/search-analytics/ports/search-analytics-port.ts +20 -0
- package/src/modules/search-analytics/types/search-analytics.ts +16 -0
- package/src/modules/search-highlighting/application/dom-highlighting-adapter.ts +36 -0
- package/src/modules/search-highlighting/domain/operations/highlighting-operations.ts +72 -0
- package/src/modules/search-highlighting/index.ts +8 -0
- package/src/modules/search-highlighting/ports/highlighting-port.ts +14 -0
- package/src/modules/search-highlighting/types/highlighting.ts +15 -0
- package/src/modules/seo-optimization/application/usecases/index.ts +18 -0
- package/src/modules/seo-optimization/domain/index.ts +12 -0
- package/src/modules/seo-optimization/domain/seoOperations.ts +92 -0
- package/src/modules/seo-optimization/index.ts +8 -0
- package/src/modules/seo-optimization/ports/index.ts +18 -0
- package/src/modules/seo-optimization/types/index.ts +41 -0
- package/src/modules/theme/application/css-theme-adapter.ts +50 -0
- package/src/modules/theme/domain/operations/theme-operations.ts +68 -0
- package/src/modules/theme/index.ts +8 -0
- package/src/modules/theme/ports/theme-port.ts +8 -0
- package/src/modules/theme/types/theme.ts +12 -0
- package/src/modules/toc/application/markdown-toc-adapter.ts +106 -0
- package/src/modules/toc/domain/operations/toc-operations.ts +92 -0
- package/src/modules/toc/index.ts +8 -0
- package/src/modules/toc/ports/toc-port.ts +21 -0
- package/src/modules/toc/types/toc.ts +17 -0
- package/src/modules/toc-generator/application/usecases/index.ts +30 -0
- package/src/modules/toc-generator/domain/index.ts +12 -0
- package/src/modules/toc-generator/domain/tocOperations.ts +104 -0
- package/src/modules/toc-generator/index.ts +9 -0
- package/src/modules/toc-generator/ports/index.ts +20 -0
- package/src/modules/toc-generator/types/index.ts +50 -0
- package/src/modules/version-control/domain/events/index.ts +39 -0
- package/src/modules/version-control/domain/models/index.ts +25 -0
- package/src/modules/version-control/domain/validators/index.ts +50 -0
- package/src/modules/versioning/application/fs-version-loader.ts +44 -0
- package/src/modules/versioning/domain/operations/versioning-operations.ts +80 -0
- package/src/modules/versioning/index.ts +8 -0
- package/src/modules/versioning/ports/version-loader-port.ts +18 -0
- package/src/modules/versioning/types/versioning.ts +17 -0
- package/src/modules/workflow/domain/events/index.ts +55 -0
- package/src/modules/workflow/domain/models/index.ts +40 -0
- package/src/modules/workflow/domain/validators/index.ts +50 -0
- package/src/modules/yaml-parser/application/js-yaml-adapter.ts +34 -0
- package/src/modules/yaml-parser/domain/operations/parse-yaml.ts +58 -0
- package/src/modules/yaml-parser/index.ts +7 -0
- package/src/modules/yaml-parser/ports/yaml-parser-port.ts +18 -0
- package/src/navigation/index.ts +9 -0
- package/src/plugin/index.ts +4 -0
- package/src/presentation/index.ts +1 -0
- package/src/presentation/live-editor/index.ts +22 -0
- package/src/presentation/live-editor/live-editor-component.ts +219 -0
- package/src/presentation/live-editor/virtual-module.ts +16 -0
- package/src/presentation/solid/CodeBlock.tsx +120 -0
- package/src/presentation/solid/Toc.tsx +58 -0
- package/src/presentation/solid/index.ts +11 -0
- package/src/presentation/vite-plugin/docs-plugin.ts +212 -0
- package/src/presentation/vite-plugin/index.ts +9 -0
- package/src/presentation/vite-plugin/transform-markdown.ts +26 -0
- package/src/runtime/analytics.ts +59 -0
- package/src/runtime/api-diff.ts +115 -0
- package/src/runtime/app.tsx +32 -0
- package/src/runtime/components/AccentPicker.tsx +114 -0
- package/src/runtime/components/ApiPlayground.tsx +332 -0
- package/src/runtime/components/AskAiDialog.tsx +127 -0
- package/src/runtime/components/BackToTop.tsx +38 -0
- package/src/runtime/components/Banner.tsx +75 -0
- package/src/runtime/components/Breadcrumbs.tsx +42 -0
- package/src/runtime/components/CollectionDropdown.tsx +85 -0
- package/src/runtime/components/CustomizeDrawer.tsx +195 -0
- package/src/runtime/components/DocMarkdown.tsx +579 -0
- package/src/runtime/components/DocPrevNext.tsx +54 -0
- package/src/runtime/components/DocToc.tsx +147 -0
- package/src/runtime/components/DocsDropdown.tsx +184 -0
- package/src/runtime/components/Footer.tsx +52 -0
- package/src/runtime/components/GitHubAuth.tsx +82 -0
- package/src/runtime/components/GitHubStats.tsx +73 -0
- package/src/runtime/components/Head.tsx +225 -0
- package/src/runtime/components/LocaleDropdown.tsx +75 -0
- package/src/runtime/components/MobileBottomNav.tsx +111 -0
- package/src/runtime/components/NotFound.tsx +139 -0
- package/src/runtime/components/PageActions.tsx +144 -0
- package/src/runtime/components/RelatedDocs.tsx +50 -0
- package/src/runtime/components/ScrollProgress.tsx +32 -0
- package/src/runtime/components/SearchPalette.tsx +333 -0
- package/src/runtime/components/ShowcaseCard.tsx +87 -0
- package/src/runtime/components/SidebarNav.tsx +237 -0
- package/src/runtime/components/Skeleton.tsx +39 -0
- package/src/runtime/components/ThemeToggle.tsx +26 -0
- package/src/runtime/components/TopNav.tsx +270 -0
- package/src/runtime/components/VersionDropdown.tsx +189 -0
- package/src/runtime/components/markdown/components.ts +280 -0
- package/src/runtime/config.ts +225 -0
- package/src/runtime/content.ts +451 -0
- package/src/runtime/context.tsx +30 -0
- package/src/runtime/data.ts +93 -0
- package/src/runtime/github.ts +226 -0
- package/src/runtime/icons.ts +32 -0
- package/src/runtime/index.ts +153 -0
- package/src/runtime/layouts/DocsLayout.tsx +144 -0
- package/src/runtime/markdown-content.css +996 -0
- package/src/runtime/pages/AbTestPage.tsx +88 -0
- package/src/runtime/pages/AnalyticsPage.tsx +90 -0
- package/src/runtime/pages/ApiDiffPage.tsx +86 -0
- package/src/runtime/pages/ApiEndpointPage.tsx +248 -0
- package/src/runtime/pages/BuilderPage.tsx +150 -0
- package/src/runtime/pages/ChangelogPage.tsx +210 -0
- package/src/runtime/pages/CollectionPage.tsx +140 -0
- package/src/runtime/pages/CommunityPage.tsx +384 -0
- package/src/runtime/pages/CreatePage.tsx +448 -0
- package/src/runtime/pages/DocPage.tsx +193 -0
- package/src/runtime/pages/EditPage.tsx +201 -0
- package/src/runtime/pages/HomePage.tsx +187 -0
- package/src/runtime/pages/IssuesPage.tsx +140 -0
- package/src/runtime/pages/OAuthCallbackPage.tsx +80 -0
- package/src/runtime/pages/PluginsPage.tsx +249 -0
- package/src/runtime/pages/ShowcasePage.tsx +202 -0
- package/src/runtime/pwa.ts +39 -0
- package/src/runtime/router.tsx +192 -0
- package/src/runtime/seo.ts +192 -0
- package/src/runtime/theme.css +175 -0
- package/src/runtime/theme.ts +224 -0
- package/src/runtime/types.ts +217 -0
- package/src/search/index.ts +6 -0
- package/src/seo-optimization/index.ts +4 -0
- package/src/shared/constants/index.ts +26 -0
- package/src/shared/errors/index.ts +195 -0
- package/src/shared/index.ts +27 -0
- package/src/shared/types/brand.ts +14 -0
- package/src/shared/types/client.d.ts +45 -0
- package/src/shared/types/either.ts +38 -0
- package/src/shared/types/index.ts +42 -0
- package/src/shared/types/option.ts +52 -0
- package/src/shared/types/result.ts +81 -0
- package/src/shared/utils/array.ts +97 -0
- package/src/shared/utils/index.ts +46 -0
- package/src/shared/utils/object.ts +47 -0
- package/src/shared/utils/string.ts +74 -0
- package/src/toc-generator/index.ts +1 -0
- package/src/types/js-yaml.d.ts +42 -0
- package/src/worker.ts +462 -0
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
import { createResource, createSignal, For, onMount, Show } from "solid-js";
|
|
2
|
+
import { DocMarkdown } from "../components/DocMarkdown";
|
|
3
|
+
import { SkeletonPage } from "../components/Skeleton";
|
|
4
|
+
import { useDocs } from "../context";
|
|
5
|
+
import {
|
|
6
|
+
fetchReleases,
|
|
7
|
+
fetchTags,
|
|
8
|
+
GitHubFetchError,
|
|
9
|
+
type ReleaseInfo,
|
|
10
|
+
type TagInfo,
|
|
11
|
+
} from "../github";
|
|
12
|
+
|
|
13
|
+
function formatDate(iso: string) {
|
|
14
|
+
try {
|
|
15
|
+
return new Date(iso).toLocaleDateString(undefined, {
|
|
16
|
+
year: "numeric",
|
|
17
|
+
month: "short",
|
|
18
|
+
day: "numeric",
|
|
19
|
+
});
|
|
20
|
+
} catch {
|
|
21
|
+
return iso;
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
export function ChangelogPage() {
|
|
26
|
+
const config = useDocs();
|
|
27
|
+
const [tab, setTab] = createSignal<"releases" | "file">("releases");
|
|
28
|
+
const [releases, setReleases] = createSignal<ReleaseInfo[]>([]);
|
|
29
|
+
const [tags, setTags] = createSignal<TagInfo[]>([]);
|
|
30
|
+
const [loading, setLoading] = createSignal(true);
|
|
31
|
+
const [error, setError] = createSignal<string | null>(null);
|
|
32
|
+
|
|
33
|
+
const currentCollection = () => config.defaultCollection ?? "";
|
|
34
|
+
|
|
35
|
+
const [fileChangelog] = createResource(
|
|
36
|
+
() => currentCollection(),
|
|
37
|
+
async (collection) => {
|
|
38
|
+
try {
|
|
39
|
+
const entries = await config.dataSource.list(collection);
|
|
40
|
+
const id = entries.find(
|
|
41
|
+
(e) =>
|
|
42
|
+
e.id.toLowerCase().includes("changelog") ||
|
|
43
|
+
e.label.toLowerCase().includes("changelog"),
|
|
44
|
+
)?.id;
|
|
45
|
+
if (!id) return null;
|
|
46
|
+
const c = await config.dataSource.get(collection, id);
|
|
47
|
+
return c.content;
|
|
48
|
+
} catch {
|
|
49
|
+
return null;
|
|
50
|
+
}
|
|
51
|
+
},
|
|
52
|
+
);
|
|
53
|
+
|
|
54
|
+
onMount(async () => {
|
|
55
|
+
const cfg = config.github;
|
|
56
|
+
if (!cfg?.releases) {
|
|
57
|
+
setLoading(false);
|
|
58
|
+
return;
|
|
59
|
+
}
|
|
60
|
+
try {
|
|
61
|
+
const [r, t] = await Promise.all([
|
|
62
|
+
fetchReleases(cfg),
|
|
63
|
+
cfg?.releases ? fetchTags(cfg) : ([] as TagInfo[]),
|
|
64
|
+
]);
|
|
65
|
+
setReleases(r);
|
|
66
|
+
setTags(t);
|
|
67
|
+
} catch (err) {
|
|
68
|
+
if (err instanceof GitHubFetchError) {
|
|
69
|
+
setError(
|
|
70
|
+
err.status === 404
|
|
71
|
+
? "Releases not found. Make sure the repository is public."
|
|
72
|
+
: `${err.message}: ${err.payload ?? ""}`.slice(0, 200),
|
|
73
|
+
);
|
|
74
|
+
} else if (err instanceof Error) {
|
|
75
|
+
setError(err.message);
|
|
76
|
+
} else {
|
|
77
|
+
setError("Could not load releases from GitHub.");
|
|
78
|
+
}
|
|
79
|
+
} finally {
|
|
80
|
+
setLoading(false);
|
|
81
|
+
}
|
|
82
|
+
});
|
|
83
|
+
|
|
84
|
+
return (
|
|
85
|
+
<div class="max-w-3xl mx-auto px-6 py-8 pb-24">
|
|
86
|
+
<h1 class="text-3xl font-bold mb-2">Changelog</h1>
|
|
87
|
+
<p class="text-muted mb-6">Releases and file-based changelog.</p>
|
|
88
|
+
|
|
89
|
+
<div class="flex items-center gap-2 mb-6 border-b border-border">
|
|
90
|
+
<button
|
|
91
|
+
type="button"
|
|
92
|
+
onClick={() => setTab("releases")}
|
|
93
|
+
class={`px-3 py-2 text-sm border-b-2 transition-colors cursor-pointer border-none bg-transparent ${
|
|
94
|
+
tab() === "releases"
|
|
95
|
+
? "border-primary text-foreground"
|
|
96
|
+
: "border-transparent text-muted hover:text-foreground"
|
|
97
|
+
}`}
|
|
98
|
+
>
|
|
99
|
+
<span class="i-mdi:tag-outline" aria-hidden="true" /> Releases
|
|
100
|
+
</button>
|
|
101
|
+
<Show when={fileChangelog()}>
|
|
102
|
+
<button
|
|
103
|
+
type="button"
|
|
104
|
+
onClick={() => setTab("file")}
|
|
105
|
+
class={`px-3 py-2 text-sm border-b-2 transition-colors cursor-pointer border-none bg-transparent ${
|
|
106
|
+
tab() === "file"
|
|
107
|
+
? "border-primary text-foreground"
|
|
108
|
+
: "border-transparent text-muted hover:text-foreground"
|
|
109
|
+
}`}
|
|
110
|
+
>
|
|
111
|
+
<span class="i-mdi:file-document-outline" aria-hidden="true" />{" "}
|
|
112
|
+
Changelog file
|
|
113
|
+
</button>
|
|
114
|
+
</Show>
|
|
115
|
+
</div>
|
|
116
|
+
|
|
117
|
+
<Show when={loading()}>
|
|
118
|
+
<SkeletonPage />
|
|
119
|
+
</Show>
|
|
120
|
+
|
|
121
|
+
<Show when={!loading() && error()}>
|
|
122
|
+
<div class="border border-destructive/30 bg-destructive/10 rounded-lg p-5 mb-6">
|
|
123
|
+
<div class="flex items-center gap-2 mb-1 text-destructive font-medium">
|
|
124
|
+
<span class="i-mdi:alert-circle" aria-hidden="true" />
|
|
125
|
+
Failed to load releases
|
|
126
|
+
</div>
|
|
127
|
+
<p class="text-sm text-destructive/90 mb-3">{error()}</p>
|
|
128
|
+
<Show when={config.site.repoUrl}>
|
|
129
|
+
<a
|
|
130
|
+
href={`${config.site.repoUrl}/releases`}
|
|
131
|
+
target="_blank"
|
|
132
|
+
rel="noreferrer"
|
|
133
|
+
class="inline-flex items-center gap-1.5 text-sm text-destructive font-medium underline underline-offset-2"
|
|
134
|
+
>
|
|
135
|
+
View on GitHub
|
|
136
|
+
<span class="i-mdi:open-in-new" aria-hidden="true" />
|
|
137
|
+
</a>
|
|
138
|
+
</Show>
|
|
139
|
+
</div>
|
|
140
|
+
</Show>
|
|
141
|
+
|
|
142
|
+
<Show when={tab() === "file" && fileChangelog()}>
|
|
143
|
+
<div class="border border-border rounded-lg p-5 bg-surface/30">
|
|
144
|
+
<DocMarkdown source={fileChangelog() ?? ""} />
|
|
145
|
+
</div>
|
|
146
|
+
</Show>
|
|
147
|
+
|
|
148
|
+
<Show when={tab() === "releases"}>
|
|
149
|
+
<Show when={!loading() && !error() && releases().length === 0}>
|
|
150
|
+
<div class="flex flex-col items-center gap-3 py-16 rounded-lg border border-dashed border-border text-muted">
|
|
151
|
+
<span class="i-mdi:history text-4xl" aria-hidden="true" />
|
|
152
|
+
<p class="m-0">No releases found for this repository.</p>
|
|
153
|
+
<Show when={config.site.repoUrl}>
|
|
154
|
+
<a
|
|
155
|
+
href={`${config.site.repoUrl}/releases/new`}
|
|
156
|
+
target="_blank"
|
|
157
|
+
rel="noreferrer"
|
|
158
|
+
class="text-sm text-primary underline underline-offset-2"
|
|
159
|
+
>
|
|
160
|
+
Create a release
|
|
161
|
+
</a>
|
|
162
|
+
</Show>
|
|
163
|
+
</div>
|
|
164
|
+
</Show>
|
|
165
|
+
|
|
166
|
+
<Show when={tags().length > 0}>
|
|
167
|
+
<div class="flex flex-wrap gap-2 mb-6">
|
|
168
|
+
<For each={tags().slice(0, 20)}>
|
|
169
|
+
{(t) => (
|
|
170
|
+
<a
|
|
171
|
+
href={`${config.site.repoUrl}/releases/tag/${t.name}`}
|
|
172
|
+
target="_blank"
|
|
173
|
+
rel="noreferrer"
|
|
174
|
+
class="text-xs px-2.5 py-1 rounded-full border border-border bg-surface text-muted hover:text-foreground hover:border-focus transition-colors no-underline"
|
|
175
|
+
>
|
|
176
|
+
{t.name}
|
|
177
|
+
</a>
|
|
178
|
+
)}
|
|
179
|
+
</For>
|
|
180
|
+
</div>
|
|
181
|
+
</Show>
|
|
182
|
+
|
|
183
|
+
<div class="space-y-6">
|
|
184
|
+
<For each={releases()}>
|
|
185
|
+
{(release) => (
|
|
186
|
+
<article class="border border-border rounded-lg p-5 bg-surface/30 hover:border-focus transition-colors">
|
|
187
|
+
<div class="flex items-center gap-2 mb-2">
|
|
188
|
+
<h2 class="text-xl font-semibold m-0">
|
|
189
|
+
<a
|
|
190
|
+
href={release.html_url}
|
|
191
|
+
target="_blank"
|
|
192
|
+
rel="noreferrer"
|
|
193
|
+
class="hover:text-primary transition-colors"
|
|
194
|
+
>
|
|
195
|
+
{release.name || release.tag_name}
|
|
196
|
+
</a>
|
|
197
|
+
</h2>
|
|
198
|
+
<span class="text-xs text-muted ml-auto">
|
|
199
|
+
{formatDate(release.published_at)}
|
|
200
|
+
</span>
|
|
201
|
+
</div>
|
|
202
|
+
<DocMarkdown source={release.body ?? "No release notes."} />
|
|
203
|
+
</article>
|
|
204
|
+
)}
|
|
205
|
+
</For>
|
|
206
|
+
</div>
|
|
207
|
+
</Show>
|
|
208
|
+
</div>
|
|
209
|
+
);
|
|
210
|
+
}
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
import { Link, useParams } from "@tanstack/solid-router";
|
|
2
|
+
import { For, Show } from "solid-js";
|
|
3
|
+
import { ShowcaseCard } from "../components/ShowcaseCard";
|
|
4
|
+
import { SkeletonPage } from "../components/Skeleton";
|
|
5
|
+
import { createDocsList, useCollections } from "../data";
|
|
6
|
+
import { categoryIcon, typeIcon } from "../icons";
|
|
7
|
+
|
|
8
|
+
export function CollectionPage() {
|
|
9
|
+
const params = useParams({ strict: false });
|
|
10
|
+
const collection = () => params().collection ?? "";
|
|
11
|
+
const collections = useCollections();
|
|
12
|
+
const meta = () => collections()?.find((c) => c.id === collection());
|
|
13
|
+
const [docs] = createDocsList(collection);
|
|
14
|
+
|
|
15
|
+
const isShowcase = () => collection() === "showcase";
|
|
16
|
+
const isApi = () => meta()?.type === "api";
|
|
17
|
+
|
|
18
|
+
return (
|
|
19
|
+
<div class="max-w-6xl mx-auto px-6 py-10 pb-24">
|
|
20
|
+
<Show when={docs.loading}>
|
|
21
|
+
<SkeletonPage />
|
|
22
|
+
</Show>
|
|
23
|
+
|
|
24
|
+
<Show when={!docs.loading}>
|
|
25
|
+
<Show
|
|
26
|
+
when={meta()}
|
|
27
|
+
fallback={
|
|
28
|
+
<div class="flex flex-col items-center gap-3 py-20 text-muted">
|
|
29
|
+
<span
|
|
30
|
+
class="i-mdi:help-circle-outline text-4xl"
|
|
31
|
+
aria-hidden="true"
|
|
32
|
+
/>
|
|
33
|
+
<h1 class="text-xl font-semibold text-foreground m-0">
|
|
34
|
+
Unknown collection
|
|
35
|
+
</h1>
|
|
36
|
+
<p class="m-0">Select a collection from the dropdown above.</p>
|
|
37
|
+
</div>
|
|
38
|
+
}
|
|
39
|
+
>
|
|
40
|
+
{(m) => (
|
|
41
|
+
<>
|
|
42
|
+
<div class="flex items-center gap-3 mb-2">
|
|
43
|
+
<span
|
|
44
|
+
class={`${m().icon} text-3xl text-primary`}
|
|
45
|
+
aria-hidden="true"
|
|
46
|
+
/>
|
|
47
|
+
<h1 class="text-2xl font-bold m-0">{m().label}</h1>
|
|
48
|
+
</div>
|
|
49
|
+
<p class="text-muted mt-0 mb-8">{m().description}</p>
|
|
50
|
+
|
|
51
|
+
<Show
|
|
52
|
+
when={docs() && (docs() ?? []).length > 0}
|
|
53
|
+
fallback={
|
|
54
|
+
<div class="flex flex-col items-center gap-3 py-16 rounded-lg border border-dashed border-border text-muted">
|
|
55
|
+
<span
|
|
56
|
+
class="i-mdi:package-variant-closed text-4xl"
|
|
57
|
+
aria-hidden="true"
|
|
58
|
+
/>
|
|
59
|
+
<p class="m-0">No documentation yet — coming soon.</p>
|
|
60
|
+
</div>
|
|
61
|
+
}
|
|
62
|
+
>
|
|
63
|
+
<Show when={isShowcase()}>
|
|
64
|
+
<div class="grid gap-4 sm:grid-cols-2 lg:grid-cols-3">
|
|
65
|
+
<For each={docs()}>
|
|
66
|
+
{(d) => (
|
|
67
|
+
<ShowcaseCard collection={collection()} doc={d} />
|
|
68
|
+
)}
|
|
69
|
+
</For>
|
|
70
|
+
</div>
|
|
71
|
+
</Show>
|
|
72
|
+
|
|
73
|
+
<Show when={!isShowcase()}>
|
|
74
|
+
<div
|
|
75
|
+
class={`grid gap-3 ${
|
|
76
|
+
isApi() ? "" : "sm:grid-cols-2 lg:grid-cols-3"
|
|
77
|
+
}`}
|
|
78
|
+
>
|
|
79
|
+
<For each={docs()}>
|
|
80
|
+
{(d) => (
|
|
81
|
+
<Link
|
|
82
|
+
to="/$collection/$docId"
|
|
83
|
+
params={{
|
|
84
|
+
collection: collection(),
|
|
85
|
+
docId: d.id,
|
|
86
|
+
}}
|
|
87
|
+
class="flex items-start gap-3 p-4 rounded-xl border border-border bg-surface/30 no-underline hover:border-focus transition-colors"
|
|
88
|
+
>
|
|
89
|
+
<span
|
|
90
|
+
class={`${typeIcon(d.type ?? "")} text-2xl text-primary shrink-0`}
|
|
91
|
+
aria-hidden="true"
|
|
92
|
+
/>
|
|
93
|
+
<div class="min-w-0 flex-1">
|
|
94
|
+
<div class="flex items-center gap-2 mb-1">
|
|
95
|
+
<span class="block text-sm font-medium text-foreground truncate">
|
|
96
|
+
{d.label}
|
|
97
|
+
</span>
|
|
98
|
+
<Show when={d.badge}>
|
|
99
|
+
<span class="text-[10px] px-1.5 py-0.5 rounded bg-primary/10 text-primary">
|
|
100
|
+
{d.badge}
|
|
101
|
+
</span>
|
|
102
|
+
</Show>
|
|
103
|
+
</div>
|
|
104
|
+
<Show when={d.description}>
|
|
105
|
+
<p class="text-xs text-muted m-0 leading-relaxed line-clamp-2">
|
|
106
|
+
{d.description}
|
|
107
|
+
</p>
|
|
108
|
+
</Show>
|
|
109
|
+
<div class="flex items-center gap-1 text-[11px] text-muted mt-2">
|
|
110
|
+
<span
|
|
111
|
+
class={categoryIcon(d.category ?? "")}
|
|
112
|
+
aria-hidden="true"
|
|
113
|
+
/>
|
|
114
|
+
{d.category}
|
|
115
|
+
<Show when={d.tags?.length}>
|
|
116
|
+
<span class="ml-auto flex gap-1">
|
|
117
|
+
<For each={d.tags!.slice(0, 3)}>
|
|
118
|
+
{(tag) => (
|
|
119
|
+
<span class="px-1.5 py-0.5 rounded bg-background border border-border text-muted">
|
|
120
|
+
{tag}
|
|
121
|
+
</span>
|
|
122
|
+
)}
|
|
123
|
+
</For>
|
|
124
|
+
</span>
|
|
125
|
+
</Show>
|
|
126
|
+
</div>
|
|
127
|
+
</div>
|
|
128
|
+
</Link>
|
|
129
|
+
)}
|
|
130
|
+
</For>
|
|
131
|
+
</div>
|
|
132
|
+
</Show>
|
|
133
|
+
</Show>
|
|
134
|
+
</>
|
|
135
|
+
)}
|
|
136
|
+
</Show>
|
|
137
|
+
</Show>
|
|
138
|
+
</div>
|
|
139
|
+
);
|
|
140
|
+
}
|