@lupinum/ginko-docs 0.3.0 → 0.4.0-rc.10

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.
Files changed (50) hide show
  1. package/README.md +12 -4
  2. package/app/app.config.ts +2 -0
  3. package/app/app.vue +26 -2
  4. package/app/assets/css/tailwind.css +24 -0
  5. package/app/assets/css/theme-presets.css +141 -0
  6. package/app/components/OgImage/GinkoDocs.satori.vue +131 -10
  7. package/app/components/site/SiteBanner.vue +2 -2
  8. package/app/components/site/SiteFooter.vue +1 -1
  9. package/app/components/site/SiteHeader.vue +1 -1
  10. package/app/components/site/SiteSocialLinks.vue +9 -1
  11. package/app/components/ui/badge/index.ts +1 -1
  12. package/app/components/ui/button/index.ts +1 -1
  13. package/app/composables/site-navigation.utils.ts +3 -7
  14. package/app/composables/useLocalizedPath.ts +3 -2
  15. package/app/error.vue +18 -8
  16. package/app/features/docs/components/DocsPageContent.vue +2 -2
  17. package/app/features/docs/components/DocsSidebarItem.vue +2 -2
  18. package/app/features/docs/components/DocsSidebarList.vue +1 -1
  19. package/app/features/docs/components/DocsToc.vue +2 -2
  20. package/app/features/search/command-center.ts +33 -0
  21. package/app/features/search/components/SiteCommandCenter.vue +25 -9
  22. package/app/features/search/components/SiteSearchPageHighlight.vue +4 -2
  23. package/app/features/search/useCommandCenter.ts +2 -2
  24. package/app/layouts/docs.vue +1 -1
  25. package/app/pages/index.vue +22 -3
  26. package/app/plugins/ginko-docs-theme.ts +1 -0
  27. package/content-collections.ts +13 -5
  28. package/content.js +16 -10
  29. package/content.ts +25 -8
  30. package/i18n/messages/global/command.ts +1 -0
  31. package/icon-bundle.ts +24 -4
  32. package/index.d.ts +1 -0
  33. package/modules/feature-routing.ts +47 -22
  34. package/modules/syntax-highlighting.ts +5 -0
  35. package/nuxt.config.ts +7 -7
  36. package/package.json +9 -4
  37. package/runtime/generate-favicons.mjs +124 -0
  38. package/server/plugins/sitemap-policy.ts +19 -0
  39. package/server/routes/.well-known/ai-catalog.json.get.ts +10 -0
  40. package/server/routes/[locale]/blog/rss.xml.get.ts +6 -1
  41. package/server/routes/blog/rss.xml.get.ts +10 -2
  42. package/server/routes/mcp/server-card.get.ts +14 -0
  43. package/server/utils/blog-feed.ts +24 -6
  44. package/server/utils/mcp-server-card.ts +45 -0
  45. package/server/utils/redirects.ts +10 -3
  46. package/server/utils/redirects.utils.ts +10 -7
  47. package/server/utils/sitemap.ts +50 -0
  48. package/shared/theme-presets.ts +3 -0
  49. package/shared/types/app-config.ts +20 -2
  50. package/shared/types/nuxt-config.ts +3 -0
@@ -1,5 +1,7 @@
1
1
  export type { GinkoDocsNeutralPalette, GinkoDocsPrimaryPalette } from "../theme-palettes";
2
+ export type { GinkoDocsThemePreset } from "../theme-presets";
2
3
  import type { GinkoDocsNeutralPalette, GinkoDocsPrimaryPalette } from "../theme-palettes";
4
+ import type { GinkoDocsThemePreset } from "../theme-presets";
3
5
 
4
6
  export type GinkoDocsLocalizedText = string | { en: string; de?: string };
5
7
 
@@ -56,11 +58,25 @@ export interface GinkoDocsHeroCodeTab {
56
58
 
57
59
  export type GinkoDocsHeroMedia =
58
60
  | { type: "image"; src: string; alt: string }
59
- | { type: "code"; code: string; language?: string; filename?: string }
60
- | { type: "code-tabs"; tabs: GinkoDocsHeroCodeTab[] };
61
+ | {
62
+ type: "code";
63
+ code: string;
64
+ language?: string;
65
+ filename?: string;
66
+ /** Let the code panel use otherwise empty viewport space on wide screens. */
67
+ layout?: "wide";
68
+ }
69
+ | {
70
+ type: "code-tabs";
71
+ tabs: GinkoDocsHeroCodeTab[];
72
+ /** Let the code panel use otherwise empty viewport space on wide screens. */
73
+ layout?: "wide";
74
+ };
61
75
 
62
76
  export interface GinkoDocsAppConfig {
63
77
  theme: {
78
+ /** Coordinated visual system. A non-default preset owns palette and surface tokens. */
79
+ preset?: GinkoDocsThemePreset;
64
80
  neutral: GinkoDocsNeutralPalette;
65
81
  primary: GinkoDocsPrimaryPalette;
66
82
  codeBlocks: GinkoDocsCodeBlockTheme;
@@ -70,6 +86,8 @@ export interface GinkoDocsAppConfig {
70
86
  name: GinkoDocsLocalizedText;
71
87
  description: GinkoDocsLocalizedText;
72
88
  url: string;
89
+ /** Square product mark used for browser icons and generated social cards. */
90
+ icon: string;
73
91
  logo: { light: string; dark: string };
74
92
  docsSidebarSwitcher: "dropdown" | "list" | "tabs";
75
93
  lupinumAttribution: boolean;
@@ -1,4 +1,5 @@
1
1
  import type { BundledTheme } from "shiki";
2
+ import type { LocaleCode } from "../../i18n/locales";
2
3
 
3
4
  export type GinkoDocsSyntaxTheme = BundledTheme;
4
5
 
@@ -10,5 +11,7 @@ export interface GinkoDocsSyntaxHighlightingConfig {
10
11
  }
11
12
 
12
13
  export interface GinkoDocsNuxtConfig {
14
+ /** Locale that owns unprefixed routes. */
15
+ primaryLocale?: LocaleCode;
13
16
  syntaxHighlighting?: GinkoDocsSyntaxHighlightingConfig;
14
17
  }