@raystack/chronicle 0.1.0-canary.111b55a

package/src/themes/default/Layout.tsx

@@ -0,0 +1,132 @@
+"use client";
+
+import { useMemo, useEffect, useRef } from "react";
+import { useLocation, Link } from "react-router-dom";
+import { cx } from "class-variance-authority";
+import { Flex, Navbar, Headline, Sidebar, Button } from "@raystack/apsara";
+import { RectangleStackIcon } from "@heroicons/react/24/outline";
+import { ClientThemeSwitcher } from "@/components/ui/client-theme-switcher";
+import { Search } from "@/components/ui/search";
+import { Footer } from "@/components/ui/footer";
+import { MethodBadge } from "@/components/api/method-badge";
+import type { ThemeLayoutProps, PageTreeItem } from "@/types";
+import styles from "./Layout.module.css";
+
+const iconMap: Record<string, React.ReactNode> = {
+  "rectangle-stack": <RectangleStackIcon width={16} height={16} />,
+  "method-get": <MethodBadge method="GET" size="micro" />,
+  "method-post": <MethodBadge method="POST" size="micro" />,
+  "method-put": <MethodBadge method="PUT" size="micro" />,
+  "method-delete": <MethodBadge method="DELETE" size="micro" />,
+  "method-patch": <MethodBadge method="PATCH" size="micro" />,
+};
+
+let savedScrollTop = 0;
+
+export function Layout({ children, config, tree, classNames }: ThemeLayoutProps) {
+  const { pathname } = useLocation();
+  const scrollRef = useRef<HTMLDivElement>(null);
+
+  useEffect(() => {
+    const el = scrollRef.current;
+    if (!el) return;
+    const onScroll = () => { savedScrollTop = el.scrollTop; };
+    el.addEventListener('scroll', onScroll);
+    return () => el.removeEventListener('scroll', onScroll);
+  }, []);
+
+  useEffect(() => {
+    const el = scrollRef.current;
+    if (el) requestAnimationFrame(() => { el.scrollTop = savedScrollTop; });
+  }, [pathname]);
+
+  return (
+    <Flex direction="column" className={cx(styles.layout, classNames?.layout)}>
+      <Navbar className={styles.header}>
+        <Navbar.Start>
+          <Link to="/" style={{ textDecoration: 'none', color: 'inherit' }}>
+            <Headline size="small" weight="medium" as="h1">
+              {config.title}
+            </Headline>
+          </Link>
+        </Navbar.Start>
+        <Navbar.End>
+          <Flex gap="medium" align="center" className={styles.navActions}>
+            {config.api?.map((api) => (
+              <Link key={api.name} to={api.basePath} className={styles.navButton}>
+                {api.name} API
+              </Link>
+            ))}
+            {config.navigation?.links?.map((link) => (
+              <Link key={link.href} to={link.href}>
+                {link.label}
+              </Link>
+            ))}
+            {config.search?.enabled && <Search />}
+          </Flex>
+          <ClientThemeSwitcher size={16} />
+        </Navbar.End>
+      </Navbar>
+      <Flex className={cx(styles.body, classNames?.body)}>
+        <Sidebar defaultOpen collapsible={false} className={cx(styles.sidebar, classNames?.sidebar)}>
+          <Sidebar.Main ref={scrollRef}>
+            {tree.children.map((item) => (
+              <SidebarNode
+                key={item.url ?? item.name}
+                item={item}
+                pathname={pathname}
+              />
+            ))}
+          </Sidebar.Main>
+        </Sidebar>
+        <main className={cx(styles.content, classNames?.content)}>{children}</main>
+      </Flex>
+      <Footer config={config.footer} />
+    </Flex>
+  );
+}
+
+function SidebarNode({
+  item,
+  pathname,
+}: {
+  item: PageTreeItem;
+  pathname: string;
+}) {
+  if (item.type === "separator") {
+    return null;
+  }
+
+  if (item.type === "folder" && item.children) {
+    return (
+      <Sidebar.Group
+        label={item.name}
+        leadingIcon={item.icon ? iconMap[item.icon] : undefined}
+        classNames={{ items: styles.groupItems }}
+      >
+        {item.children.map((child) => (
+          <SidebarNode
+            key={child.url ?? child.name}
+            item={child}
+            pathname={pathname}
+          />
+        ))}
+      </Sidebar.Group>
+    );
+  }
+
+  const isActive = pathname === item.url;
+  const href = item.url ?? "#";
+  const link = useMemo(() => <Link to={href} />, [href]);
+
+  return (
+    <Sidebar.Item
+      href={href}
+      active={isActive}
+      leadingIcon={item.icon ? iconMap[item.icon] : undefined}
+      as={link}
+    >
+      {item.name}
+    </Sidebar.Item>
+  );
+}

package/src/themes/default/Page.module.css

@@ -0,0 +1,106 @@
+.page {
+  gap: var(--rs-space-9);
+}
+
+.article {
+  flex: 1;
+  min-width: 0;
+  max-width: 768px;
+}
+
+.content {
+  line-height: 1.7;
+}
+
+.content h1,
+.content h2,
+.content h3,
+.content h4,
+.content h5,
+.content h6 {
+  margin-top: var(--rs-space-8);
+  margin-bottom: var(--rs-space-5);
+  line-height: 1.4;
+}
+
+.content ul,
+.content ol {
+  padding-left: var(--rs-space-5);
+  margin-bottom: var(--rs-space-5);
+}
+
+.content li {
+  font-size: var(--rs-font-size-regular);
+  margin: var(--rs-space-2) 0;
+}
+
+.content [role="tablist"] {
+  margin-bottom: var(--rs-space-3);
+}
+
+.content :global(pre) {
+  background-color: var(--shiki-light-bg, #fff);
+}
+
+.content :global(pre code span) {
+  color: var(--shiki-light);
+}
+
+:global([data-theme="dark"]) .content :global(pre) {
+  background-color: var(--shiki-dark-bg, #24292e);
+}
+
+:global([data-theme="dark"]) .content :global(pre code span) {
+  color: var(--shiki-dark);
+}
+
+.content img {
+  max-width: 100%;
+  height: auto;
+}
+
+.content table {
+  display: block;
+  max-width: 100%;
+  overflow-x: auto;
+  margin-bottom: var(--rs-space-5);
+}
+
+.content details {
+  border: 1px solid var(--rs-color-border-base-primary);
+  border-radius: var(--rs-radius-2);
+  margin: var(--rs-space-5) 0;
+  overflow: hidden;
+}
+
+.content details summary {
+  padding: var(--rs-space-4) var(--rs-space-5);
+  cursor: pointer;
+  font-weight: 500;
+  font-size: var(--rs-font-size-small);
+  color: var(--rs-color-text-base-primary);
+  background: var(--rs-color-background-base-secondary);
+  list-style: none;
+  display: flex;
+  align-items: center;
+  gap: var(--rs-space-3);
+}
+
+.content details summary::-webkit-details-marker {
+  display: none;
+}
+
+.content details summary::before {
+  content: '▶';
+  font-size: 10px;
+  transition: transform 0.2s ease;
+  color: var(--rs-color-text-base-secondary);
+}
+
+.content details[open] > summary::before {
+  transform: rotate(90deg);
+}
+
+.content details > :not(summary) {
+  padding: var(--rs-space-4) var(--rs-space-5);
+}

package/src/themes/default/Page.tsx

@@ -0,0 +1,21 @@
+'use client'
+
+import { Flex } from '@raystack/apsara'
+import type { ThemePageProps } from '@/types'
+import { Breadcrumbs } from '@/components/ui/breadcrumbs'
+import { Toc } from './Toc'
+import styles from './Page.module.css'
+
+export function Page({ page, tree }: ThemePageProps) {
+  return (
+    <Flex className={styles.page}>
+      <article className={styles.article}>
+        <Breadcrumbs slug={page.slug} tree={tree} />
+        <div className={styles.content}>
+          {page.content}
+        </div>
+      </article>
+      <Toc items={page.toc} />
+    </Flex>
+  )
+}

package/src/themes/default/Toc.module.css

@@ -0,0 +1,48 @@
+.toc {
+  width: 200px;
+  flex-shrink: 0;
+  position: sticky;
+  top: var(--rs-space-9);
+  max-height: calc(100vh - var(--rs-space-17));
+  overflow-y: auto;
+}
+
+.title {
+  display: block;
+  color: var(--rs-color-foreground-base-secondary);
+  text-transform: uppercase;
+  letter-spacing: 0.05em;
+  margin-bottom: var(--rs-space-3);
+  font-size: var(--rs-font-size-mini);
+}
+
+.nav {
+  display: flex;
+  flex-direction: column;
+  gap: 0;
+  border-left: 1px solid var(--rs-color-border-base-primary);
+  padding-left: var(--rs-space-3);
+  margin-bottom: var(--rs-space-6);
+}
+
+.link {
+  color: var(--rs-color-foreground-base-tertiary);
+  text-decoration: none;
+  font-size: var(--rs-font-size-small);
+  line-height: 1.4;
+  padding: var(--rs-space-1) 0;
+  transition: color 0.15s ease;
+}
+
+.link:hover {
+  color: var(--rs-color-foreground-base-primary);
+}
+
+.active {
+  color: var(--rs-color-foreground-base-primary);
+  font-weight: 500;
+}
+
+.nested {
+  padding-left: var(--rs-space-3);
+}

package/src/themes/default/Toc.tsx

@@ -0,0 +1,66 @@
+'use client'
+
+import { useEffect, useState } from 'react'
+import { Text } from '@raystack/apsara'
+import type { TocItem } from '@/types'
+import styles from './Toc.module.css'
+
+interface TocProps {
+  items: TocItem[]
+}
+
+export function Toc({ items }: TocProps) {
+  const [activeId, setActiveId] = useState<string>('')
+
+  // Filter to only show h2 and h3 headings
+  const filteredItems = items.filter((item) => item.depth >= 2 && item.depth <= 3)
+
+  useEffect(() => {
+    const headingIds = filteredItems.map((item) => item.url.replace('#', ''))
+
+    const observer = new IntersectionObserver(
+      (entries) => {
+        entries.forEach((entry) => {
+          if (entry.isIntersecting) {
+            setActiveId(entry.target.id)
+          }
+        })
+      },
+      // -80px top: offset for fixed header, -80% bottom: trigger when heading is in top 20% of viewport
+      { rootMargin: '-80px 0px -80% 0px' }
+    )
+
+    headingIds.forEach((id) => {
+      const element = document.getElementById(id)
+      if (element) observer.observe(element)
+    })
+
+    return () => observer.disconnect()
+  }, [filteredItems])
+
+  if (filteredItems.length === 0) return null
+
+  return (
+    <aside className={styles.toc}>
+      <Text size={1} weight="medium" className={styles.title}>
+        On this page
+      </Text>
+      <nav className={styles.nav}>
+        {filteredItems.map((item) => {
+          const id = item.url.replace('#', '')
+          const isActive = activeId === id
+          const isNested = item.depth > 2
+          return (
+            <a
+              key={item.url}
+              href={item.url}
+              className={`${styles.link} ${isActive ? styles.active : ''} ${isNested ? styles.nested : ''}`}
+            >
+              {item.title}
+            </a>
+          )
+        })}
+      </nav>
+    </aside>
+  )
+}

package/src/themes/default/font.ts

@@ -0,0 +1,4 @@
+export const inter = {
+  className: 'chronicle-inter',
+  style: { fontFamily: "'Inter', system-ui, -apple-system, sans-serif" },
+}

package/src/themes/default/index.ts

@@ -0,0 +1,13 @@
+import { Layout } from './Layout'
+import { Page } from './Page'
+import { Toc } from './Toc'
+import { inter } from './font'
+import type { Theme } from '@/types'
+
+export const defaultTheme: Theme = {
+  Layout,
+  Page,
+  className: inter.className,
+}
+
+export { Layout, Page, Toc }

package/src/themes/paper/ChapterNav.module.css

@@ -0,0 +1,71 @@
+.nav {
+  display: flex;
+  flex-direction: column;
+  gap: var(--rs-space-5);
+}
+
+.chapter {
+  display: flex;
+  flex-direction: column;
+  gap: var(--rs-space-2);
+}
+
+.chapterLabel {
+  font-size: var(--rs-font-size-small);
+  font-weight: 600;
+  text-transform: uppercase;
+  letter-spacing: 0.05em;
+  color: var(--rs-color-foreground-base-primary);
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
+}
+
+.chapterItems {
+  list-style: none;
+  padding: 0;
+  margin: 0;
+  display: flex;
+  flex-direction: column;
+  gap: var(--rs-space-1);
+  padding-left: var(--rs-space-4);
+}
+
+.link {
+  display: flex;
+  align-items: center;
+  gap: var(--rs-space-2);
+  font-size: var(--rs-font-size-small);
+  color: var(--rs-color-foreground-base-tertiary);
+  text-decoration: none;
+  padding: var(--rs-space-1) 0;
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
+}
+
+.link:hover {
+  color: var(--rs-color-foreground-base-primary);
+}
+
+.active {
+  color: var(--rs-color-foreground-accent-primary);
+  font-weight: 500;
+}
+
+.icon {
+  display: flex;
+  align-items: center;
+  flex-shrink: 0;
+}
+
+.subLabel {
+  font-size: var(--rs-font-size-small);
+  font-weight: 500;
+  color: var(--rs-color-foreground-base-secondary);
+  margin-top: var(--rs-space-3);
+  display: block;
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
+}

package/src/themes/paper/ChapterNav.tsx

@@ -0,0 +1,95 @@
+'use client'
+
+import { useLocation, Link } from 'react-router-dom'
+import { MethodBadge } from '@/components/api/method-badge'
+import type { PageTree, PageTreeItem } from '@/types'
+import styles from './ChapterNav.module.css'
+
+const iconMap: Record<string, React.ReactNode> = {
+  'method-get': <MethodBadge method="GET" size="micro" />,
+  'method-post': <MethodBadge method="POST" size="micro" />,
+  'method-put': <MethodBadge method="PUT" size="micro" />,
+  'method-delete': <MethodBadge method="DELETE" size="micro" />,
+  'method-patch': <MethodBadge method="PATCH" size="micro" />,
+}
+
+interface ChapterNavProps {
+  tree: PageTree
+}
+
+function buildChapterIndices(children: PageTreeItem[]): Map<PageTreeItem, number> {
+  const indices = new Map<PageTreeItem, number>()
+  let index = 0
+  for (const item of children) {
+    if (item.type === 'folder' && item.children) {
+      index++
+      indices.set(item, index)
+    }
+  }
+  return indices
+}
+
+export function ChapterNav({ tree }: ChapterNavProps) {
+  const { pathname } = useLocation()
+  const chapterIndices = buildChapterIndices(tree.children)
+
+  return (
+    <nav className={styles.nav}>
+      <ul className={styles.chapterItems}>
+        {tree.children.map((item) => {
+          if (item.type === 'separator') return null
+
+          if (item.type === 'folder' && item.children) {
+            const chapterIndex = chapterIndices.get(item) ?? 0
+            return (
+              <li key={item.name} className={styles.chapter}>
+                <span className={styles.chapterLabel}>
+                  {String(chapterIndex).padStart(2, '0')}. {item.name}
+                </span>
+                <ul className={styles.chapterItems}>
+                  {item.children.map((child) => (
+                    <ChapterItem key={child.url ?? child.name} item={child} pathname={pathname} />
+                  ))}
+                </ul>
+              </li>
+            )
+          }
+
+          return <ChapterItem key={item.url ?? item.name} item={item} pathname={pathname} />
+        })}
+      </ul>
+    </nav>
+  )
+}
+
+function ChapterItem({ item, pathname }: { item: PageTreeItem; pathname: string }) {
+  if (item.type === 'separator') return null
+
+  if (item.type === 'folder' && item.children) {
+    return (
+      <li>
+        <span className={styles.subLabel}>{item.name}</span>
+        <ul className={styles.chapterItems}>
+          {item.children.map((child) => (
+            <ChapterItem key={child.url ?? child.name} item={child} pathname={pathname} />
+          ))}
+        </ul>
+      </li>
+    )
+  }
+
+  const isActive = pathname === item.url
+  const icon = item.icon ? iconMap[item.icon] : null
+
+  return (
+    <li>
+      <Link
+        to={item.url ?? '#'}
+        className={`${styles.link} ${isActive ? styles.active : ''}`}
+      >
+        {icon && <span className={styles.icon}>{icon}</span>}
+        <span>{item.name}</span>
+      </Link>
+    </li>
+  )
+}

package/src/themes/paper/Layout.module.css

@@ -0,0 +1,33 @@
+.layout {
+  --paper-sidebar-width: 260px;
+
+  min-height: 100vh;
+}
+
+.body {
+  flex: 1;
+}
+
+.sidebar {
+  width: var(--paper-sidebar-width);
+  padding: var(--rs-space-7) var(--rs-space-5);
+  background: var(--rs-color-background-neutral-primary);
+  overflow-y: auto;
+  font-family: 'SF Mono', 'Fira Code', 'Fira Mono', 'Roboto Mono', monospace;
+}
+
+.title {
+  text-transform: uppercase;
+  letter-spacing: 0.08em;
+  color: var(--rs-color-foreground-accent-primary);
+  font-family: inherit;
+  font-size: var(--rs-font-size-mono-large);
+  margin-bottom: var(--rs-space-7);
+}
+
+.content {
+  flex: 1;
+  overflow-y: auto;
+  background: var(--rs-color-background-neutral-primary);
+  padding-right: var(--paper-sidebar-width);
+}

package/src/themes/paper/Layout.tsx

@@ -0,0 +1,25 @@
+'use client'
+
+import { Flex, Headline } from '@raystack/apsara'
+import { cx } from 'class-variance-authority'
+import { Footer } from '@/components/ui/footer'
+import { ChapterNav } from './ChapterNav'
+import type { ThemeLayoutProps } from '@/types'
+import styles from './Layout.module.css'
+
+export function Layout({ children, config, tree, classNames }: ThemeLayoutProps) {
+  return (
+    <Flex direction="column" className={cx(styles.layout, classNames?.layout)}>
+      <Flex className={cx(styles.body, classNames?.body)}>
+        <aside className={cx(styles.sidebar, classNames?.sidebar)}>
+          <Headline size="small" weight="medium" as="h1" className={styles.title}>
+            {config.title}
+          </Headline>
+          <ChapterNav tree={tree} />
+        </aside>
+        <div className={cx(styles.content, classNames?.content)}>{children}</div>
+      </Flex>
+      <Footer config={config.footer} />
+    </Flex>
+  )
+}