ardo 1.0.0 → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sebastian Software GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,123 @@
+# ardo
+
+React-first Static Documentation Framework built on TanStack Start.
+
+## Quick Start
+
+Scaffold a new project with the CLI:
+
+```bash
+pnpm create ardo@latest my-docs
+cd my-docs
+pnpm install
+pnpm dev
+```
+
+## Manual Installation
+
+```bash
+pnpm add ardo @tanstack/react-start @tanstack/react-router react react-dom
+pnpm add -D typescript vite tailwindcss
+```
+
+## Usage
+
+### Configuration
+
+Create a `press.config.ts` in your project root:
+
+```typescript
+import { defineConfig } from 'ardo/config'
+
+export default defineConfig({
+  title: 'My Documentation',
+  description: 'Built with Ardo',
+
+  themeConfig: {
+    nav: [{ text: 'Guide', link: '/guide/getting-started' }],
+    sidebar: [
+      {
+        text: 'Guide',
+        items: [{ text: 'Getting Started', link: '/guide/getting-started' }],
+      },
+    ],
+  },
+})
+```
+
+### Vite Plugin
+
+Add the plugin to your `vite.config.ts`:
+
+```typescript
+import { defineConfig } from 'vite'
+import { tanstackStart } from '@tanstack/react-start/plugin/vite'
+import react from '@vitejs/plugin-react'
+import { ardoPlugin } from 'ardo/vite'
+
+export default defineConfig({
+  plugins: [
+    tanstackStart({
+      prerender: {
+        enabled: true,
+        crawlLinks: true,
+      },
+    }),
+    react(),
+    ardoPlugin(),
+  ],
+})
+```
+
+### Runtime Hooks
+
+Access configuration and page data in your components:
+
+```tsx
+import { useConfig, useSidebar, usePageData, useTOC } from 'ardo/runtime'
+
+function MyComponent() {
+  const config = useConfig()
+  const sidebar = useSidebar()
+  const page = usePageData()
+  const toc = useTOC()
+
+  return <h1>{config.title}</h1>
+}
+```
+
+### Theme Components
+
+Use pre-built components for your documentation:
+
+```tsx
+import { DocPage, Layout, Header, Sidebar, TOC } from 'ardo/theme'
+
+function App() {
+  return (
+    <DocPage>
+      <YourContent />
+    </DocPage>
+  )
+}
+```
+
+## Exports
+
+| Export                  | Description                              |
+| ----------------------- | ---------------------------------------- |
+| `ardo/config`           | Configuration utilities (`defineConfig`) |
+| `ardo/vite`             | Vite plugin (`ardoPlugin`)               |
+| `ardo/runtime`          | React hooks and providers                |
+| `ardo/theme`            | Pre-built UI components                  |
+| `ardo/theme/styles.css` | Default theme styles                     |
+
+## Documentation
+
+Full documentation available at [sebastian-software.github.io/ardo](https://sebastian-software.github.io/ardo/)
+
+LLM-optimized documentation: [llms-full.txt](https://sebastian-software.github.io/ardo/llms-full.txt)
+
+## License
+
+[MIT](../../LICENSE) © [Sebastian Software GmbH](https://sebastian-software.de)

package/dist/CopyButton-mw16Gpik.d.ts

@@ -0,0 +1,335 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import { S as SidebarItem } from './types-ChK5MqjO.js';
+
+interface LayoutProps {
+    /** Header content */
+    header?: ReactNode;
+    /** Sidebar content */
+    sidebar?: ReactNode;
+    /** Footer content */
+    footer?: ReactNode;
+    /** Main content */
+    children: ReactNode;
+    /** Additional CSS classes */
+    className?: string;
+}
+/**
+ * Layout component with explicit slot props.
+ *
+ * @example
+ * ```tsx
+ * <Layout
+ *   header={<Header logo="/logo.svg" title="Ardo" nav={...} />}
+ *   sidebar={<Sidebar>...</Sidebar>}
+ *   footer={<Footer message="MIT License" />}
+ * >
+ *   <Outlet />
+ * </Layout>
+ * ```
+ */
+declare function Layout({ header, sidebar, footer, children, className }: LayoutProps): react_jsx_runtime.JSX.Element;
+
+interface HeaderProps {
+    /** Logo image URL or light/dark variants */
+    logo?: string | {
+        light: string;
+        dark: string;
+    };
+    /** Site title displayed next to logo */
+    title?: string;
+    /** Navigation content (Nav component or custom) */
+    nav?: ReactNode;
+    /** Actions/right side content (social links, custom buttons) */
+    actions?: ReactNode;
+    /** Show search (default: true) */
+    search?: boolean;
+    /** Show theme toggle (default: true) */
+    themeToggle?: boolean;
+    /** Additional CSS classes */
+    className?: string;
+}
+/**
+ * Header component with explicit slot props.
+ *
+ * @example
+ * ```tsx
+ * <Header
+ *   logo="/logo.svg"
+ *   title="Ardo"
+ *   nav={
+ *     <Nav>
+ *       <NavLink to="/guide">Guide</NavLink>
+ *       <NavLink to="/api">API</NavLink>
+ *     </Nav>
+ *   }
+ *   actions={
+ *     <SocialLink href="https://github.com/..." icon="github" />
+ *   }
+ * />
+ * ```
+ */
+declare function Header({ logo, title, nav, actions, search, themeToggle, className, }: HeaderProps): react_jsx_runtime.JSX.Element;
+interface SocialLinkProps {
+    /** URL to link to */
+    href: string;
+    /** Social icon type */
+    icon: 'github' | 'twitter' | 'discord' | 'linkedin' | 'youtube' | 'npm';
+    /** Accessible label */
+    ariaLabel?: string;
+    /** Additional CSS classes */
+    className?: string;
+}
+/**
+ * Social media link with icon.
+ *
+ * @example
+ * ```tsx
+ * <SocialLink href="https://github.com/..." icon="github" />
+ * ```
+ */
+declare function SocialLink({ href, icon, ariaLabel, className }: SocialLinkProps): react_jsx_runtime.JSX.Element;
+
+interface SidebarProps {
+    /** Sidebar items (for data-driven approach) */
+    items?: SidebarItem[];
+    /** Children for JSX composition (SidebarGroup, SidebarLink) */
+    children?: ReactNode;
+    /** Additional CSS classes */
+    className?: string;
+}
+/**
+ * Sidebar component supporting both data-driven and JSX composition patterns.
+ *
+ * @example Data-driven (items prop)
+ * ```tsx
+ * <Sidebar items={[
+ *   { text: 'Introduction', link: '/intro' },
+ *   { text: 'Guide', items: [
+ *     { text: 'Getting Started', link: '/guide/getting-started' }
+ *   ]}
+ * ]} />
+ * ```
+ *
+ * @example JSX composition
+ * ```tsx
+ * <Sidebar>
+ *   <SidebarLink to="/intro">Introduction</SidebarLink>
+ *   <SidebarGroup title="Guide">
+ *     <SidebarLink to="/guide/getting-started">Getting Started</SidebarLink>
+ *   </SidebarGroup>
+ * </Sidebar>
+ * ```
+ */
+declare function Sidebar({ items, children, className }: SidebarProps): react_jsx_runtime.JSX.Element;
+interface SidebarGroupProps {
+    /** Group title */
+    title: string;
+    /** Optional link for the group title */
+    to?: string;
+    /** Initial collapsed state (default: false) */
+    collapsed?: boolean;
+    /** Whether group is collapsible (default: true if has children) */
+    collapsible?: boolean;
+    /** Children (SidebarLink, nested SidebarGroup) */
+    children?: ReactNode;
+    /** Additional CSS classes */
+    className?: string;
+}
+/**
+ * Group component for organizing sidebar links.
+ *
+ * @example
+ * ```tsx
+ * <SidebarGroup title="Guide">
+ *   <SidebarLink to="/guide/intro">Introduction</SidebarLink>
+ *   <SidebarLink to="/guide/setup">Setup</SidebarLink>
+ * </SidebarGroup>
+ * ```
+ *
+ * @example With collapsible state
+ * ```tsx
+ * <SidebarGroup title="Advanced" collapsed>
+ *   <SidebarLink to="/advanced/config">Configuration</SidebarLink>
+ * </SidebarGroup>
+ * ```
+ */
+declare function SidebarGroup({ title, to, collapsed: initialCollapsed, collapsible, children, className, }: SidebarGroupProps): react_jsx_runtime.JSX.Element;
+interface SidebarLinkProps {
+    /** Internal route path */
+    to: string;
+    /** Link text */
+    children: ReactNode;
+    /** Additional CSS classes */
+    className?: string;
+}
+/**
+ * Sidebar navigation link.
+ *
+ * @example
+ * ```tsx
+ * <SidebarLink to="/guide/getting-started">Getting Started</SidebarLink>
+ * ```
+ */
+declare function SidebarLink({ to, children, className }: SidebarLinkProps): react_jsx_runtime.JSX.Element;
+
+interface FooterProps {
+    /** Footer message (supports HTML string) */
+    message?: string;
+    /** Copyright text (supports HTML string) */
+    copyright?: string;
+    /** Custom content (overrides message/copyright) */
+    children?: ReactNode;
+    /** Additional CSS classes */
+    className?: string;
+}
+/**
+ * Footer component with message and copyright props.
+ *
+ * @example Simple usage
+ * ```tsx
+ * <Footer message="MIT License" copyright="2026 Sebastian Software" />
+ * ```
+ *
+ * @example With HTML
+ * ```tsx
+ * <Footer
+ *   message="Built with <a href='...'>Ardo</a>"
+ *   copyright="Copyright &copy; 2026"
+ * />
+ * ```
+ *
+ * @example Custom content
+ * ```tsx
+ * <Footer>
+ *   <CustomFooterContent />
+ * </Footer>
+ * ```
+ */
+declare function Footer({ message, copyright, children, className }: FooterProps): react_jsx_runtime.JSX.Element | null;
+interface FooterMessageProps {
+    children: ReactNode;
+    className?: string;
+}
+interface FooterCopyrightProps {
+    children: ReactNode;
+    className?: string;
+}
+
+declare function TOC(): react_jsx_runtime.JSX.Element | null;
+
+interface ContentProps {
+    children: ReactNode;
+}
+declare function Content({ children }: ContentProps): react_jsx_runtime.JSX.Element;
+
+interface DocPageProps {
+    children: ReactNode;
+}
+/**
+ * Full documentation page with Layout wrapper.
+ * Use this when you don't have a _layout.tsx file.
+ *
+ * @example
+ * ```tsx
+ * <DocPage>
+ *   <Content />
+ * </DocPage>
+ * ```
+ */
+declare function DocPage({ children }: DocPageProps): react_jsx_runtime.JSX.Element;
+interface DocContentProps {
+    children: ReactNode;
+}
+/**
+ * Documentation content without Layout wrapper.
+ * Use this when you have a _layout.tsx that provides the Layout.
+ *
+ * @example
+ * ```tsx
+ * // In _layout.tsx:
+ * <Layout>
+ *   <Header ... />
+ *   <Sidebar ... />
+ *   <Outlet />
+ *   <Footer ... />
+ * </Layout>
+ *
+ * // In page routes:
+ * <DocContent>
+ *   <MarkdownContent />
+ * </DocContent>
+ * ```
+ */
+declare function DocContent({ children }: DocContentProps): react_jsx_runtime.JSX.Element;
+interface DocLayoutProps {
+    content: ReactNode;
+}
+/**
+ * @deprecated Use DocPage or DocContent instead
+ */
+declare function DocLayout({ content }: DocLayoutProps): react_jsx_runtime.JSX.Element;
+
+declare function HomePage(): react_jsx_runtime.JSX.Element;
+
+declare function ThemeToggle(): react_jsx_runtime.JSX.Element;
+
+declare function Search(): react_jsx_runtime.JSX.Element;
+
+interface CodeBlockProps {
+    code: string;
+    language?: string;
+    title?: string;
+    lineNumbers?: boolean;
+    highlightLines?: number[];
+    children?: React.ReactNode;
+}
+declare function CodeBlock({ code, language, title, lineNumbers, highlightLines, children, }: CodeBlockProps): react_jsx_runtime.JSX.Element;
+interface CodeGroupProps {
+    children: React.ReactNode;
+}
+declare function CodeGroup({ children }: CodeGroupProps): react_jsx_runtime.JSX.Element;
+
+type ContainerType = 'tip' | 'warning' | 'danger' | 'info' | 'note';
+interface ContainerProps {
+    type: ContainerType;
+    title?: string;
+    children: ReactNode;
+}
+declare function Container({ type, title, children }: ContainerProps): react_jsx_runtime.JSX.Element;
+declare function Tip({ title, children }: Omit<ContainerProps, 'type'>): react_jsx_runtime.JSX.Element;
+declare function Warning({ title, children }: Omit<ContainerProps, 'type'>): react_jsx_runtime.JSX.Element;
+declare function Danger({ title, children }: Omit<ContainerProps, 'type'>): react_jsx_runtime.JSX.Element;
+declare function Info({ title, children }: Omit<ContainerProps, 'type'>): react_jsx_runtime.JSX.Element;
+declare function Note({ title, children }: Omit<ContainerProps, 'type'>): react_jsx_runtime.JSX.Element;
+
+interface TabsProps {
+    defaultValue?: string;
+    children: ReactNode;
+}
+declare function Tabs({ defaultValue, children }: TabsProps): react_jsx_runtime.JSX.Element;
+interface TabListProps {
+    children: ReactNode;
+}
+declare function TabList({ children }: TabListProps): react_jsx_runtime.JSX.Element;
+interface TabProps {
+    value: string;
+    children: ReactNode;
+}
+declare function Tab({ value, children }: TabProps): react_jsx_runtime.JSX.Element;
+interface TabPanelProps {
+    value: string;
+    children: ReactNode;
+}
+declare function TabPanel({ value, children }: TabPanelProps): react_jsx_runtime.JSX.Element | null;
+interface TabPanelsProps {
+    children: ReactNode;
+}
+declare function TabPanels({ children }: TabPanelsProps): react_jsx_runtime.JSX.Element;
+
+interface CopyButtonProps {
+    code: string;
+}
+declare function CopyButton({ code }: CopyButtonProps): react_jsx_runtime.JSX.Element;
+
+export { SocialLink as A, type SocialLinkProps as B, CodeBlock as C, Danger as D, Footer as F, Header as H, Info as I, Layout as L, Note as N, Search as S, TOC as T, Warning as W, CodeGroup as a, Container as b, Content as c, CopyButton as d, DocLayout as e, DocPage as f, HomePage as g, Sidebar as h, Tab as i, TabList as j, TabPanel as k, TabPanels as l, Tabs as m, ThemeToggle as n, Tip as o, DocContent as p, type FooterCopyrightProps as q, type FooterMessageProps as r, type FooterProps as s, type HeaderProps as t, type LayoutProps as u, SidebarGroup as v, type SidebarGroupProps as w, SidebarLink as x, type SidebarLinkProps as y, type SidebarProps as z };