@wrikka/create-docs 0.1.0

package/docs/data-sources.md

@@ -0,0 +1,88 @@
+---
+title: Data Sources
+description: Filesystem, remote, composite, and custom data sources.
+order: 6
+category: Guide
+tags: [data]
+---
+
+# Data Sources
+
+## Static / filesystem
+
+```ts
+import { createStaticDataSource } from "@wrikka/create-docs/solid";
+
+const files = import.meta.glob("./docs/**/*.{md,yml,yaml}", {
+  query: "?raw",
+  import: "default",
+  eager: true,
+}) as Record<string, string>;
+
+const dataSource = createStaticDataSource({
+  collections: [
+    {
+      meta: { id: "docs", label: "Docs" },
+      files,
+    },
+  ],
+  drafts: true,
+});
+```
+
+Supports frontmatter, `_dir.yml` navigation, drafts, scheduled publishing, and MiniSearch.
+
+### ArkType schema per collection
+
+```ts
+import { type } from "arktype";
+
+const docSchema = type({
+  title: "string",
+  "description?": "string",
+  "order?": "number",
+  "tags?": "string[]",
+});
+
+const dataSource = createStaticDataSource({
+  collections: [{ meta: { id: "docs", label: "Docs" }, files, schema: docSchema }],
+});
+```
+
+## Remote
+
+```ts
+import { createRemoteDataSource } from "@wrikka/create-docs/solid";
+
+const dataSource = createRemoteDataSource({
+  collection: "docs",
+  baseUrl: "https://api.example.com/docs",
+});
+```
+
+## Composite
+
+Combine multiple data sources:
+
+```ts
+import { createCompositeDataSource } from "@wrikka/create-docs/solid";
+
+const dataSource = createCompositeDataSource([
+  staticSource,
+  createRemoteDataSource({ collection: "api", baseUrl: "https://api.example.com" }),
+]);
+```
+
+## Custom
+
+Implement `DocsDataSource`:
+
+```ts
+interface DocsDataSource {
+  collections(): Promise<CollectionMeta[]>;
+  list(collection: string): Promise<DocEntry[]>;
+  get(collection: string, id: string): Promise<DocContent>;
+  search(q: string, collection?: string): Promise<SearchResult[]>;
+  query?(q: DocQuery): Promise<DocEntry[]>;
+}
+```

package/docs/deploy.md

@@ -0,0 +1,38 @@
+---
+title: Deployment
+description: Build, output, and deploy the docs site.
+order: 7
+category: Guide
+tags: [deploy]
+---
+
+# Deployment
+
+## Build
+
+The CLI scaffolds a Vite + SolidJS app. Build it with:
+
+```bash
+bun run build
+```
+
+The default output is in `dist/`.
+
+## Static hosting
+
+`create-docs` is a client-side SPA. Deploy `dist/` to any static host:
+
+- Vercel
+- Netlify
+- Cloudflare Pages
+- GitHub Pages
+
+Configure a catch-all redirect to `index.html` so deep links work.
+
+## Environment variables
+
+Set `DOCS_BASE_URL` to bake the public URL into `site.url` at build time if your app reads it.
+
+## SEO artifacts
+
+Use the exported generators to produce `/sitemap.xml`, `/robots.txt`, `/rss.xml`, `/feed.atom`, `/feed.json`, and `/llms.txt`.

package/docs/features.md

@@ -0,0 +1,51 @@
+---
+title: Features
+description: Search, SEO, API references, analytics, PWA, and more.
+order: 5
+category: Guide
+tags: [features]
+---
+
+# Features
+
+## Search
+
+`SearchPalette` indexes the data source with MiniSearch. Press `Ctrl+K` or `/` to open it.
+
+## SEO
+
+Every page gets:
+
+- `<title>` and `<meta>` tags
+- `og:type`, `og:title`, `og:description`, `og:url`, `og:image`
+- `twitter:card`
+- `canonical`, `hreflang` alternates
+- JSON-LD `WebSite`, `BreadcrumbList`, `TechArticle`
+- RSS, Atom, and JSON feed `<link>` tags
+
+Framework helpers:
+
+```ts
+import { generateSitemap, generateRobots, generateAtom, generateJsonFeed, generateLlmsTxt } from "@wrikka/create-docs/solid";
+```
+
+## API references
+
+A collection with `type: "api"` renders an API reference layout. Provide `endpoints` and the runtime builds a playground for each route.
+
+## GitHub integration
+
+Set `site.repoUrl` to enable:
+
+- Edit / source / report issue / open PR actions
+- GitHub releases / changelog
+- Repository stats
+- Contributors and milestones
+
+## Analytics
+
+Enable `features.analytics` to track page views locally and visit `/analytics` for a dashboard.
+
+## PWA
+
+Enable `features.pwa` and a `manifest.webmanifest` is generated; `setupPwa()` registers a service worker.

package/docs/getting-started.md

@@ -0,0 +1,42 @@
+---
+title: Getting Started
+description: Scaffold a site and mount the runtime.
+order: 2
+category: Guide
+tags: [setup]
+---
+
+# Getting Started
+
+## Scaffold
+
+<code-group>
+
+```bash [bun]
+bun create @wrikka/docs my-docs
+```
+
+```bash [npm]
+npm create @wrikka/docs my-docs
+```
+
+</code-group>
+
+## Mount the app
+
+```tsx
+import { mountDocsApp } from "@wrikka/create-docs/solid";
+import "@wrikka/create-docs/theme.css";
+import "@wrikka/create-docs/markdown-content.css";
+
+mountDocsApp({
+  site: { title: "My Docs" },
+  dataSource,
+});
+```
+
+## The data source contract
+
+The runtime talks to a `DocsDataSource` — a small interface with
+`collections()`, `list()`, `get()`, `search()`, and optional `ask()` and
+`query()`. Ship content from a filesystem glob, an oRPC backend, or any CMS.

package/docs/index.md

@@ -0,0 +1,34 @@
+---
+title: Introduction
+description: What create-docs is and why it exists.
+order: 1
+category: Guide
+tags: [intro]
+---
+
+# create-docs
+
+**create-docs** is a documentation runtime for SolidJS — think VitePress-style
+docs with Scalar-like API references, driven entirely by a pluggable data
+source.
+
+## What you get
+
+- Markdown docs with callouts, code groups, steps, Mermaid, and math
+- Full-text search, breadcrumbs, edit links, last-updated
+- GitHub integration: releases changelog, stats, contributors, milestones
+- API reference collections with an interactive playground
+- PWA, analytics, i18n, and versioning switches
+
+## Quick start
+
+```bash
+bun create @wrikka/docs my-docs
+cd my-docs
+bun install
+bun run dev
+```
+
+> [!TIP]
+> Every markdown file under `docs/` becomes a page — frontmatter controls
+> title, order, badges, drafts, and more.

package/docs/markdown.md

@@ -0,0 +1,154 @@
+---
+title: Markdown Syntax
+description: Callouts, code groups, steps, playgrounds, UI components, and more.
+order: 3
+category: Guide
+tags: [markdown]
+---
+
+# Markdown Syntax
+
+## Callouts
+
+> [!NOTE]
+> Useful information readers should know.
+
+> [!TIP]
+> A helpful suggestion.
+
+> [!WARNING]
+> Something to be careful about.
+
+> [!DANGER]
+> A destructive or risky action.
+
+## Code groups
+
+<code-group>
+
+```ts [pnpm]
+pnpm create @wrikka/docs my-docs
+```
+
+```ts [bun]
+bun create @wrikka/docs my-docs
+```
+
+</code-group>
+
+## Steps (tutorials)
+
+<steps>
+
+1. Install the package
+2. Write markdown under `docs/`
+3. Run the dev server
+
+</steps>
+
+## Live playground
+
+<playground>
+
+```html
+<button style="padding:8px 16px;border-radius:8px;background:#7ee787;border:0">
+	Hello docs
+</button>
+```
+
+</playground>
+
+## UI components
+
+### Cards
+
+<card-grid>
+
+<card title="Getting Started" icon="i-mdi:rocket-launch" to="/docs/getting-started">
+  Scaffold a site and mount the runtime.
+</card>
+
+<card title="Configuration" icon="i-mdi:cog" to="/docs/config">
+  Site, features, i18n, versioning, and navigation config.
+</card>
+
+</card-grid>
+
+### Tabs
+
+<tabs>
+
+<tab label="npm">
+
+```bash
+npm create @wrikka/docs my-docs
+```
+
+</tab>
+
+<tab label="bun">
+
+```bash
+bun create @wrikka/docs my-docs
+```
+
+</tab>
+
+</tabs>
+
+### File tree
+
+<file-tree>
+
+<folder name="my-docs">
+  <folder name="docs">
+    <file name="index.md" />
+    <file name="getting-started.md" />
+  </folder>
+  <file name="package.json" />
+</folder>
+
+</file-tree>
+
+### Badges and keys
+
+Use <badge text="new" type="primary" /> for status and <kbd>Ctrl + K</kbd> for keyboard shortcuts.
+
+### Accordion
+
+<accordion>
+
+<item title="Why create-docs?">
+  It combines VitePress-like docs, Scalar-like API references, and a pluggable data source in one SolidJS runtime.
+</item>
+
+<item title="Can I use a remote CMS?">
+  Yes — implement `DocsDataSource` or use `createRemoteDataSource`.
+</item>
+
+</accordion>
+
+### Timeline
+
+<timeline>
+
+<event date="2024-06-01" title="Initial release">
+  First stable release of create-docs.
+</event>
+
+<event date="2025-01-15" title="API references">
+  Added interactive API playground and OpenAPI support.
+</event>
+
+</timeline>
+
+## Math
+
+$$e^{i\pi} + 1 = 0$$
+
+## Mermaid
+
+```mermaid
+graph LR
+  A[Markdown] --> B[create-docs] --> C[Site]
+```

package/docs/theming.md

@@ -0,0 +1,53 @@
+---
+title: Theming
+description: Customize colors, fonts, and UnoCSS shortcuts.
+order: 8
+category: Guide
+tags: [theme]
+---
+
+# Theming
+
+## CSS variables
+
+`theme.css` exposes design tokens. Override them in your own CSS:
+
+```css
+:root {
+  --rt-bg: #ffffff;
+  --rt-fg: #1a1a1a;
+  --rt-border: #e3e3e3;
+  --rt-accent: #2ea043;
+  --rt-accent-2: #1f6feb;
+}
+
+html.dark {
+  --rt-bg: #0d1117;
+  --rt-fg: #c9d1d9;
+  --rt-border: #30363d;
+  --rt-accent: #3fb950;
+  --rt-accent-2: #58a6ff;
+}
+```
+
+## UnoCSS
+
+The runtime ships utility-first classes. Extend shortcuts in your `uno.config.ts`:
+
+```ts
+import { defineConfig } from "unocss";
+
+export default defineConfig({
+  shortcuts: {
+    "docs-card": "rounded border border-border p-4 bg-surface",
+  },
+});
+```
+
+## Dark mode
+
+Call `initTheme("dark")` or `"system"` before mounting. The theme toggle uses `data-theme` and `html.dark`.
+
+## Reduced motion
+
+All motion respects `prefers-reduced-motion: reduce`.

package/package.json

@@ -0,0 +1,142 @@
+{
+	"name": "@wrikka/create-docs",
+	"description": "Vite plugin for documentation sites built on Functional Clean Architecture with SolidJS support",
+	"version": "0.1.0",
+	"type": "module",
+	"bin": {
+		"create-docs": "./bin/cli.js",
+		"create-docs-pull": "./scripts/github-pull.ts"
+	},
+	"files": [
+		"bin",
+		"dist",
+		"src",
+		"README.md",
+		"docs",
+		"./dist",
+		"scripts"
+	],
+	"module": "./dist/index.js",
+	"main": "./dist/index.cjs",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"import": {
+				"types": "./dist/index.d.ts",
+				"default": "./dist/index.js"
+			},
+			"require": {
+				"types": "./dist/index.d.cts",
+				"default": "./dist/index.cjs"
+			}
+		},
+		"./solid": {
+			"types": "./src/runtime/index.ts",
+			"default": "./src/runtime/index.ts"
+		},
+		"./seo": "./src/runtime/seo.ts",
+		"./theme.css": "./src/runtime/theme.css",
+		"./markdown-content.css": "./src/runtime/markdown-content.css",
+		"./package.json": "./package.json"
+	},
+	"sideEffects": false,
+	"keywords": [
+		"docs",
+		"documentation",
+		"vite",
+		"plugin",
+		"solidjs",
+		"solid-js",
+		"mdx",
+		"markdown",
+		"content",
+		"vite-plugin",
+		"clean-architecture"
+	],
+	"author": "Wrikka",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/wrikka/create-docs"
+	},
+	"bugs": {
+		"url": "https://github.com/wrikka/create-docs/issues"
+	},
+	"homepage": "https://github.com/wrikka/create-docs#readme",
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"dev": "vite dev",
+		"dev:lib": "bun run src/index.ts",
+		"build": "bunup",
+		"build:site": "vite build && bun run scripts/generate-docs-index.ts",
+		"build:watch": "bunup --watch",
+		"typecheck": "tsc --noEmit",
+		"typecheck:watch": "tsc --noEmit --watch",
+		"lint": "biome check",
+		"lint:fix": "biome check --write",
+		"format": "biome check --write",
+		"test": "vitest run --passWithNoTests",
+		"test:watch": "vitest",
+		"test:coverage": "vitest run --coverage",
+		"scan": "ast-grep scan",
+		"check": "bun run lint && bun run typecheck && bun run scan",
+		"verify": "bun run check && bun run test && bun run build",
+		"deps:analyze": "bunx depcheck",
+		"clean": "bunx rimraf dist node_modules",
+		"security": "bunx audit",
+		"pull": "bun scripts/github-pull.ts"
+	},
+	"dependencies": {
+		"@codemirror/basic-setup": "^0.20.0",
+		"@codemirror/lang-markdown": "^6.5.2",
+		"@codemirror/state": "^6.7.4",
+		"@codemirror/view": "^6.43.11",
+		"@comark/html": "^0.6.2",
+		"@mdx-js/mdx": "^3.1.1",
+		"@monaco-editor/react": "^4.7.0",
+		"arktype": "^2.2.3",
+		"beautiful-mermaid": "^1.1.3",
+		"comark": "^0.6.2",
+		"js-yaml": "^5.4.1",
+		"katex": "^0.18.6",
+		"marked": "^18.0.11",
+		"minisearch": "^7.2.0",
+		"monaco-editor": "^0.56.0",
+		"rangi": "^2.2.0",
+		"simple-git": "^3.36.0",
+		"solid-js": "^1.9.15",
+		"velite": "^0.4.0"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "^2.5.12",
+		"@iconify-json/mdi": "^1.2.3",
+		"@tanstack/solid-router": "^1.170.30",
+		"@types/bun": "^1.4.1",
+		"@types/node": "^26.4.1",
+		"bunup": "^0.16.32",
+		"typescript": "^7.0.2",
+		"unocss": "^66.10.0",
+		"vite": "^8.2.2",
+		"vite-plugin-solid": "^2.11.14",
+		"vitest": "^5.0.0"
+	},
+	"peerDependencies": {
+		"vite": "^8.2.2",
+		"solid-js": "^1.9.0",
+		"@tanstack/solid-router": "^1.170.30"
+	},
+	"peerDependenciesMeta": {
+		"solid-js": {
+			"optional": false
+		},
+		"@tanstack/solid-router": {
+			"optional": false
+		}
+	},
+	"engines": {
+		"node": ">=20 <22",
+		"bun": ">=1.3.10 <2.0.0"
+	}
+}