@raystack/chronicle 0.3.0 → 0.5.0

package/src/themes/default/Layout.tsx

@@ -1,64 +1,86 @@
-"use client";
-
-import { useMemo, useEffect, useRef } from "react";
-import { usePathname } from "next/navigation";
-import NextLink from "next/link";
-import { cx } from "class-variance-authority";
-import { Flex, Navbar, Headline, Link, 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";
+import { RectangleStackIcon } from '@heroicons/react/24/outline';
+import {
+  Button,
+  Flex,
+  Headline,
+  Link,
+  Navbar,
+  Sidebar
+} from '@raystack/apsara';
+import { cx } from 'class-variance-authority';
+import { useEffect, useRef } from 'react';
+import { Link as RouterLink, useLocation } from 'react-router';
+import { MethodBadge } from '@/components/api/method-badge';
+import { ClientThemeSwitcher } from '@/components/ui/client-theme-switcher';
+import { Footer } from '@/components/ui/footer';
+import { Search } from '@/components/ui/search';
+import type { Node } from 'fumadocs-core/page-tree';
+import type { ThemeLayoutProps } 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" />,
+  '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 = usePathname();
+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; };
+    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; });
+    if (el)
+      requestAnimationFrame(() => {
+        el.scrollTop = savedScrollTop;
+      });
   }, [pathname]);
 
   return (
-    <Flex direction="column" className={cx(styles.layout, classNames?.layout)}>
+    <Flex direction='column' className={cx(styles.layout, classNames?.layout)}>
       <Navbar className={styles.header}>
         <Navbar.Start>
-          <NextLink href="/" style={{ textDecoration: 'none', color: 'inherit' }}>
-            <Headline size="small" weight="medium" as="h1">
+          <RouterLink
+            to='/'
+            style={{ textDecoration: 'none', color: 'inherit' }}
+          >
+            <Headline size='small' weight='medium' as='h1'>
               {config.title}
             </Headline>
-          </NextLink>
+          </RouterLink>
         </Navbar.Start>
         <Navbar.End>
-          <Flex gap="medium" align="center" className={styles.navActions}>
-            {config.api?.map((api) => (
-              <NextLink key={api.basePath} href={api.basePath} className={styles.navButton}>
+          <Flex gap='medium' align='center' className={styles.navActions}>
+            {config.api?.map(api => (
+              <RouterLink
+                key={api.basePath}
+                to={api.basePath}
+                className={styles.navButton}
+              >
                 {api.name} API
-              </NextLink>
+              </RouterLink>
             ))}
-            {config.navigation?.links?.map((link) => (
+            {config.navigation?.links?.map(link => (
               <Link key={link.href} href={link.href}>
                 {link.label}
               </Link>
@@ -69,18 +91,24 @@ export function Layout({ children, config, tree, classNames }: ThemeLayoutProps)
         </Navbar.End>
       </Navbar>
       <Flex className={cx(styles.body, classNames?.body)}>
-        <Sidebar defaultOpen collapsible={false} className={cx(styles.sidebar, classNames?.sidebar)}>
+        <Sidebar
+          defaultOpen
+          collapsible={false}
+          className={cx(styles.sidebar, classNames?.sidebar)}
+        >
           <Sidebar.Main ref={scrollRef}>
-            {tree.children.map((item) => (
+            {tree.children.map((item, i) => (
               <SidebarNode
-                key={item.url ?? item.name}
+                key={item.type === 'page' ? item.url : (item.name?.toString() ?? i)}
                 item={item}
                 pathname={pathname}
               />
             ))}
           </Sidebar.Main>
         </Sidebar>
-        <main className={cx(styles.content, classNames?.content)}>{children}</main>
+        <main className={cx(styles.content, classNames?.content)}>
+          {children}
+        </main>
       </Flex>
       <Footer config={config.footer} />
     </Flex>
@@ -89,25 +117,26 @@ export function Layout({ children, config, tree, classNames }: ThemeLayoutProps)
 
 function SidebarNode({
   item,
-  pathname,
+  pathname
 }: {
-  item: PageTreeItem;
+  item: Node;
   pathname: string;
 }) {
-  if (item.type === "separator") {
+  if (item.type === 'separator') {
     return null;
   }
 
-  if (item.type === "folder" && item.children) {
+  if (item.type === 'folder') {
+    const icon = typeof item.icon === 'string' ? iconMap[item.icon] : item.icon;
     return (
       <Sidebar.Group
-        label={item.name}
-        leadingIcon={item.icon ? iconMap[item.icon] : undefined}
+        label={item.name?.toString() ?? ''}
+        leadingIcon={icon ?? undefined}
         classNames={{ items: styles.groupItems }}
       >
-        {item.children.map((child) => (
+        {item.children.map((child, i) => (
           <SidebarNode
-            key={child.url ?? child.name}
+            key={child.type === 'page' ? child.url : (child.name?.toString() ?? i)}
             item={child}
             pathname={pathname}
           />
@@ -117,14 +146,15 @@ function SidebarNode({
   }
 
   const isActive = pathname === item.url;
-  const href = item.url ?? "#";
-  const link = useMemo(() => <NextLink href={href} scroll={false} />, [href]);
+  const href = item.url ?? '#';
+  const icon = typeof item.icon === 'string' ? iconMap[item.icon] : item.icon;
+  const link = <RouterLink to={href} />;
 
   return (
     <Sidebar.Item
       href={href}
       active={isActive}
-      leadingIcon={item.icon ? iconMap[item.icon] : undefined}
+      leadingIcon={icon ?? undefined}
       as={link}
     >
       {item.name}

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

@@ -38,9 +38,53 @@
   margin-bottom: var(--rs-space-3);
 }
 
+.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

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

package/src/themes/default/Toc.tsx

@@ -1,55 +1,41 @@
-'use client'
+'use client';
 
-import { useEffect, useState } from 'react'
-import { Text } from '@raystack/apsara'
-import type { TocItem } from '@/types'
-import styles from './Toc.module.css'
+import { Text } from '@raystack/apsara';
+import { AnchorProvider, useActiveAnchor } from 'fumadocs-core/toc';
+import type { TableOfContents, TOCItemType } from 'fumadocs-core/toc';
+import styles from './Toc.module.css';
 
 interface TocProps {
-  items: TocItem[]
+  items: TableOfContents;
 }
 
 export function Toc({ items }: TocProps) {
-  const [activeId, setActiveId] = useState<string>('')
+  const filteredItems = items.filter(
+    item => item.depth >= 2 && item.depth <= 3
+  );
 
-  // Filter to only show h2 and h3 headings
-  const filteredItems = items.filter((item) => item.depth >= 2 && item.depth <= 3)
+  if (filteredItems.length === 0) return null;
 
-  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])
+  return (
+    <AnchorProvider toc={filteredItems} single>
+      <TocContent items={filteredItems} />
+    </AnchorProvider>
+  );
+}
 
-  if (filteredItems.length === 0) return null
+function TocContent({ items }: { items: TOCItemType[] }) {
+  const activeAnchor = useActiveAnchor();
 
   return (
     <aside className={styles.toc}>
-      <Text size={1} weight="medium" className={styles.title}>
+      <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
+        {items.map(item => {
+          const id = item.url.replace('#', '');
+          const isActive = activeAnchor === id;
+          const isNested = item.depth > 2;
           return (
             <a
               key={item.url}
@@ -58,9 +44,9 @@ export function Toc({ items }: TocProps) {
             >
               {item.title}
             </a>
-          )
+          );
         })}
       </nav>
     </aside>
-  )
+  );
 }

package/src/themes/default/index.ts

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

package/src/themes/paper/ChapterNav.tsx

@@ -1,96 +1,115 @@
-'use client'
-
-import { usePathname } from 'next/navigation'
-import NextLink from 'next/link'
-import { MethodBadge } from '@/components/api/method-badge'
-import type { PageTree, PageTreeItem } from '@/types'
-import styles from './ChapterNav.module.css'
+import { Link as RouterLink, useLocation } from 'react-router';
+import { MethodBadge } from '@/components/api/method-badge';
+import type { Root, Node } from 'fumadocs-core/page-tree';
+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" />,
-}
+  '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
+  tree: Root;
 }
 
-function buildChapterIndices(children: PageTreeItem[]): Map<PageTreeItem, number> {
-  const indices = new Map<PageTreeItem, number>()
-  let index = 0
+function buildChapterIndices(
+  children: Node[]
+): Map<Node, number> {
+  const indices = new Map<Node, number>();
+  let index = 0;
   for (const item of children) {
-    if (item.type === 'folder' && item.children) {
-      index++
-      indices.set(item, index)
+    if (item.type === 'folder') {
+      index++;
+      indices.set(item, index);
     }
   }
-  return indices
+  return indices;
 }
 
 export function ChapterNav({ tree }: ChapterNavProps) {
-  const pathname = usePathname()
-  const chapterIndices = buildChapterIndices(tree.children)
+  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
+        {tree.children.map(item => {
+          if (item.type === 'separator') return null;
 
-          if (item.type === 'folder' && item.children) {
-            const chapterIndex = chapterIndices.get(item) ?? 0
+          if (item.type === 'folder') {
+            const chapterIndex = chapterIndices.get(item) ?? 0;
             return (
-              <li key={item.name} className={styles.chapter}>
+              <li key={item.name?.toString()} 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} />
+                  {item.children.map(child => (
+                    <ChapterItem
+                      key={child.type === 'page' ? child.url : (child.name?.toString() ?? '')}
+                      item={child}
+                      pathname={pathname}
+                    />
                   ))}
                 </ul>
               </li>
-            )
+            );
           }
 
-          return <ChapterItem key={item.url ?? item.name} item={item} pathname={pathname} />
+          return (
+            <ChapterItem
+              key={item.url ?? item.name?.toString() ?? ''}
+              item={item}
+              pathname={pathname}
+            />
+          );
         })}
       </ul>
     </nav>
-  )
+  );
 }
 
-function ChapterItem({ item, pathname }: { item: PageTreeItem; pathname: string }) {
-  if (item.type === 'separator') return null
+function ChapterItem({
+  item,
+  pathname
+}: {
+  item: Node;
+  pathname: string;
+}) {
+  if (item.type === 'separator') return null;
 
-  if (item.type === 'folder' && item.children) {
+  if (item.type === 'folder') {
     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} />
+          {item.children.map(child => (
+            <ChapterItem
+              key={child.type === 'page' ? child.url : (child.name?.toString() ?? '')}
+              item={child}
+              pathname={pathname}
+            />
           ))}
         </ul>
       </li>
-    )
+    );
   }
 
-  const isActive = pathname === item.url
-  const icon = item.icon ? iconMap[item.icon] : null
+  const isActive = pathname === item.url;
+  const icon = typeof item.icon === 'string' ? iconMap[item.icon] : item.icon;
 
   return (
     <li>
-      <NextLink
-        href={item.url ?? '#'}
+      <RouterLink
+        to={item.url ?? '#'}
         className={`${styles.link} ${isActive ? styles.active : ''}`}
       >
         {icon && <span className={styles.icon}>{icon}</span>}
         <span>{item.name}</span>
-      </NextLink>
+      </RouterLink>
     </li>
-  )
+  );
 }

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

@@ -13,7 +13,7 @@
   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;
+  font-family: "SF Mono", "Fira Code", "Fira Mono", "Roboto Mono", monospace;
 }
 
 .title {

package/src/themes/paper/Layout.tsx

@@ -1,25 +1,37 @@
-'use client'
+'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'
+import { Flex, Headline } from '@raystack/apsara';
+import { cx } from 'class-variance-authority';
+import { Footer } from '@/components/ui/footer';
+import type { ThemeLayoutProps } from '@/types';
+import { ChapterNav } from './ChapterNav';
+import styles from './Layout.module.css';
 
-export function Layout({ children, config, tree, classNames }: ThemeLayoutProps) {
+export function Layout({
+  children,
+  config,
+  tree,
+  classNames
+}: ThemeLayoutProps) {
   return (
-    <Flex direction="column" className={cx(styles.layout, classNames?.layout)}>
+    <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}>
+          <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>
+        <div className={cx(styles.content, classNames?.content)}>
+          {children}
+        </div>
       </Flex>
       <Footer config={config.footer} />
     </Flex>
-  )
+  );
 }