@raystack/chronicle 0.1.0-canary.111b55a

package/src/themes/registry.ts

@@ -0,0 +1,14 @@
+import type { Theme } from '@/types'
+import { defaultTheme } from './default'
+import { paperTheme } from './paper'
+
+const themes: Record<string, Theme> = {
+  default: defaultTheme,
+  paper: paperTheme,
+}
+
+export function getTheme(name?: string): Theme {
+  if (!name || !themes[name]) return defaultTheme
+
+  return themes[name]
+}

package/src/types/config.ts

@@ -0,0 +1,80 @@
+export interface ChronicleConfig {
+  title: string
+  description?: string
+  url?: string
+  logo?: LogoConfig
+  theme?: ThemeConfig
+  navigation?: NavigationConfig
+  search?: SearchConfig
+  footer?: FooterConfig
+  api?: ApiConfig[]
+  llms?: LlmsConfig
+  analytics?: AnalyticsConfig
+}
+
+export interface LlmsConfig {
+  enabled?: boolean
+}
+
+export interface AnalyticsConfig {
+  enabled?: boolean
+  googleAnalytics?: GoogleAnalyticsConfig
+}
+
+export interface GoogleAnalyticsConfig {
+  measurementId: string
+}
+
+export interface ApiConfig {
+  name: string
+  spec: string
+  basePath: string
+  server: ApiServerConfig
+  auth?: ApiAuthConfig
+}
+
+export interface ApiServerConfig {
+  url: string
+  description?: string
+}
+
+export interface ApiAuthConfig {
+  type: string
+  header: string
+  placeholder?: string
+}
+
+export interface LogoConfig {
+  light?: string
+  dark?: string
+}
+
+export interface ThemeConfig {
+  name: 'default' | 'paper'
+  colors?: Record<string, string>
+}
+
+export interface NavigationConfig {
+  links?: NavLink[]
+  social?: SocialLink[]
+}
+
+export interface NavLink {
+  label: string
+  href: string
+}
+
+export interface SocialLink {
+  type: 'github' | 'twitter' | 'discord' | string
+  href: string
+}
+
+export interface SearchConfig {
+  enabled?: boolean
+  placeholder?: string
+}
+
+export interface FooterConfig {
+  copyright?: string
+  links?: NavLink[]
+}

package/src/types/content.ts

@@ -0,0 +1,36 @@
+import type { ReactNode } from 'react'
+
+export interface Frontmatter {
+  title: string
+  description?: string
+  order?: number
+  icon?: string
+  lastModified?: string
+}
+
+export interface Page {
+  slug: string[]
+  frontmatter: Frontmatter
+  content: ReactNode
+  toc: TocItem[]
+}
+
+export interface TocItem {
+  title: string
+  url: string
+  depth: number
+}
+
+export interface PageTreeItem {
+  type: 'page' | 'folder' | 'separator'
+  name: string
+  url?: string
+  order?: number
+  icon?: string
+  children?: PageTreeItem[]
+}
+
+export interface PageTree {
+  name: string
+  children: PageTreeItem[]
+}

package/src/types/index.ts

@@ -0,0 +1,3 @@
+export * from './config'
+export * from './content'
+export * from './theme'

package/src/types/theme.ts

@@ -0,0 +1,22 @@
+import type { ReactNode } from 'react'
+import type { ChronicleConfig } from './config'
+import type { Page, PageTree } from './content'
+
+export interface ThemeLayoutProps {
+  children: ReactNode
+  config: ChronicleConfig
+  tree: PageTree
+  classNames?: { layout?: string; body?: string; sidebar?: string; content?: string }
+}
+
+export interface ThemePageProps {
+  page: Page
+  config: ChronicleConfig
+  tree: PageTree
+}
+
+export interface Theme {
+  Layout: React.ComponentType<ThemeLayoutProps>
+  Page: React.ComponentType<ThemePageProps>
+  className?: string
+}

package/tsconfig.json

@@ -0,0 +1,29 @@
+{
+  "compilerOptions": {
+    "composite": false,
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "inlineSources": false,
+    "isolatedModules": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "preserveWatchOutput": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "jsx": "react-jsx",
+    "module": "ESNext",
+    "target": "es6",
+    "outDir": "dist",
+    "rootDir": ".",
+    "baseUrl": ".",
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "moduleResolution": "bundler",
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist"]
+}