ardo 1.0.0 → 1.0.2

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,110 @@
+# ardo
+
+React-first Static Documentation Framework built on TanStack Start.
+
+## 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/)
+
+## License
+
+[MIT](../../LICENSE) © [Sebastian Software GmbH](https://sebastian-software.de)