@wrikka/create-docs 0.1.0

package/src/runtime/github.ts

@@ -0,0 +1,226 @@
+import { getGitHubToken } from "./components/GitHubAuth";
+import type { GitHubConfig } from "./config";
+
+export interface ReleaseInfo {
+	id: number;
+	tag_name: string;
+	name: string;
+	body: string;
+	published_at: string;
+	html_url: string;
+	author: { login: string; avatar_url: string };
+}
+
+export interface RepoStats {
+	stars: number;
+	forks: number;
+	openIssues: number;
+	openPRs: number;
+}
+
+export interface Contributor {
+	login: string;
+	avatar_url: string;
+	html_url: string;
+	contributions: number;
+}
+
+export interface CommitInfo {
+	sha: string;
+	message: string;
+	author: string;
+	date: string;
+	html_url: string;
+}
+
+function githubBaseUrl(): string {
+	// In production builds, use the Cloudflare Worker proxy so a GITHUB_TOKEN
+	// can be attached server-side. In dev, call the GitHub API directly.
+	return import.meta.env.PROD ? "/api/github" : "https://api.github.com";
+}
+
+export function githubApiUrl(config: GitHubConfig, path: string): string {
+	return `${githubBaseUrl()}/repos/${config.owner}/${config.repo}${path}`;
+}
+
+export class GitHubFetchError extends Error {
+	status: number;
+	payload?: string;
+	constructor(status: number, message: string, payload?: string) {
+		super(message);
+		this.status = status;
+		this.payload = payload;
+	}
+}
+
+async function fetchJson<T>(url: string): Promise<T> {
+	const token = getGitHubToken();
+	const res = await fetch(url, {
+		headers: {
+			Accept: "application/vnd.github+json",
+			...(token ? { Authorization: `Bearer ${token}` } : {}),
+		},
+	});
+	const text = await res.text();
+	if (!res.ok) {
+		throw new GitHubFetchError(
+			res.status,
+			`GitHub API error ${res.status}`,
+			text,
+		);
+	}
+	try {
+		return JSON.parse(text) as T;
+	} catch {
+		throw new GitHubFetchError(res.status, "Invalid JSON from GitHub", text);
+	}
+}
+
+export async function fetchReleases(
+	config: GitHubConfig,
+): Promise<ReleaseInfo[]> {
+	return fetchJson<ReleaseInfo[]>(
+		githubApiUrl(config, "/releases?per_page=30"),
+	);
+}
+
+export async function fetchRepoStats(config: GitHubConfig): Promise<RepoStats> {
+	const [repo, pulls] = await Promise.all([
+		fetchJson<{
+			stargazers_count: number;
+			forks_count: number;
+			open_issues_count: number;
+		}>(githubApiUrl(config, "")),
+		fetchJson<{ total_count: number }>(
+			`${githubBaseUrl()}/search/issues?q=repo:${config.owner}/${config.repo}+type:pr+state:open&per_page=1`,
+		),
+	]);
+	return {
+		stars: repo.stargazers_count,
+		forks: repo.forks_count,
+		openIssues: repo.open_issues_count,
+		openPRs: pulls.total_count,
+	};
+}
+
+export async function fetchContributors(
+	config: GitHubConfig,
+): Promise<Contributor[]> {
+	return fetchJson<Contributor[]>(
+		githubApiUrl(config, "/contributors?per_page=100"),
+	);
+}
+
+export async function fetchCommits(
+	config: GitHubConfig,
+	branch?: string,
+): Promise<CommitInfo[]> {
+	const ref = branch ?? "main";
+	const raw = await fetchJson<
+		{
+			sha: string;
+			commit: { message: string; author: { name: string; date: string } };
+			html_url: string;
+		}[]
+	>(githubApiUrl(config, `/commits?sha=${ref}&per_page=20`));
+	return raw.map((r) => ({
+		sha: r.sha.slice(0, 7),
+		message: r.commit.message.split("\n")[0] ?? "",
+		author: r.commit.author.name,
+		date: r.commit.author.date,
+		html_url: r.html_url,
+	}));
+}
+
+export interface TagInfo {
+	name: string;
+	sha: string;
+	commit: { sha: string; url: string };
+}
+
+export interface BranchInfo {
+	name: string;
+	commit: { sha: string };
+}
+
+export interface IssueInfo {
+	number: number;
+	title: string;
+	state: string;
+	html_url: string;
+	created_at: string;
+	updated_at: string;
+	comments: number;
+	user: { login: string; avatar_url: string };
+	labels: { name: string; color: string }[];
+}
+
+export interface MilestoneInfo {
+	number: number;
+	title: string;
+	description: string | null;
+	state: string;
+	open_issues: number;
+	closed_issues: number;
+	due_on: string | null;
+	html_url: string;
+}
+
+export async function fetchMilestones(
+	config: GitHubConfig,
+): Promise<MilestoneInfo[]> {
+	return fetchJson<MilestoneInfo[]>(
+		githubApiUrl(config, "/milestones?state=all&per_page=50"),
+	);
+}
+
+export async function fetchTags(config: GitHubConfig): Promise<TagInfo[]> {
+	return fetchJson<TagInfo[]>(githubApiUrl(config, "/tags?per_page=30"));
+}
+
+export async function fetchBranches(
+	config: GitHubConfig,
+): Promise<BranchInfo[]> {
+	return fetchJson<BranchInfo[]>(githubApiUrl(config, "/branches?per_page=30"));
+}
+
+export async function fetchLatestCommit(
+	config: GitHubConfig,
+	branch?: string,
+): Promise<CommitInfo> {
+	const ref = branch ?? config.branch ?? "main";
+	const raw = await fetchJson<{
+		sha: string;
+		commit: { message: string; author: { name: string; date: string } };
+		html_url: string;
+	}>(githubApiUrl(config, `/commits/${ref}`));
+	return {
+		sha: raw.sha.slice(0, 7),
+		message: raw.commit.message.split("\n")[0] ?? "",
+		author: raw.commit.author.name,
+		date: raw.commit.author.date,
+		html_url: raw.html_url,
+	};
+}
+
+export async function fetchIssues(config: GitHubConfig): Promise<IssueInfo[]> {
+	return fetchJson<IssueInfo[]>(
+		githubApiUrl(config, "/issues?state=open&sort=updated&per_page=30"),
+	);
+}
+
+export function shieldsBadge(
+	owner: string,
+	repo: string,
+	type: "stars" | "forks" | "issues" | "prs",
+): string {
+	const label =
+		type === "stars"
+			? "stars"
+			: type === "forks"
+				? "forks"
+				: type === "issues"
+					? "issues"
+					: "prs";
+	return `https://img.shields.io/github/${type === "prs" ? "issues-pr" : type}/${owner}/${repo}?style=flat-square&label=${label}`;
+}

package/src/runtime/icons.ts

@@ -0,0 +1,32 @@
+const categoryIcons: Record<string, string> = {
+	Root: "i-mdi:file-tree-outline",
+	"CLI Apps": "i-mdi:console",
+	"Desktop Apps": "i-mdi:application-outline",
+	"TUI Apps": "i-mdi:monitor",
+	"WASM Apps": "i-mdi:application-braces-outline",
+	"Web Apps": "i-mdi:web",
+	Domain: "i-mdi:domain",
+	Infra: "i-mdi:server-outline",
+	Tools: "i-mdi:tools",
+	Foundation: "i-mdi:layers-outline",
+	Libraries: "i-mdi:bookshelf",
+	"TUI Lib": "i-mdi:console-line",
+	"Tauri Plugin": "i-mdi:power-plug-outline",
+	"Services Apps": "i-mdi:cloud-outline",
+	"Toolkits Apps": "i-mdi:toolbox-outline",
+};
+
+export function categoryIcon(category: string): string {
+	return categoryIcons[category] ?? "i-mdi:folder-outline";
+}
+
+const typeIcons: Record<string, string> = {
+	rust: "i-mdi:language-rust",
+	npm: "i-mdi:nodejs",
+	api: "i-mdi:api",
+	md: "i-mdi:language-markdown-outline",
+};
+
+export function typeIcon(type: string): string {
+	return typeIcons[type] ?? "i-mdi:file-document-outline";
+}

package/src/runtime/index.ts

@@ -0,0 +1,153 @@
+/**
+ * create-docs runtime — SolidJS app shell (VitePress-style layouts,
+ * Scalar-style API reference) driven by an injected data source.
+ */
+
+export type { PageViewRecord } from "./analytics";
+export {
+	getPageViews,
+	resetPageViews,
+	trackPageView,
+} from "./analytics";
+export type { EndpointChange } from "./api-diff";
+export { diffApiCollections } from "./api-diff";
+export { createDocsApp, mountDocsApp } from "./app";
+// Components (for custom pages/layouts)
+export { AccentPicker } from "./components/AccentPicker";
+export { ApiPlayground } from "./components/ApiPlayground";
+export { AskAiDialog } from "./components/AskAiDialog";
+export { BackToTop } from "./components/BackToTop";
+export { Breadcrumbs } from "./components/Breadcrumbs";
+export { CollectionDropdown } from "./components/CollectionDropdown";
+export { DocMarkdown } from "./components/DocMarkdown";
+export { DocPrevNext } from "./components/DocPrevNext";
+export { DocsDropdown } from "./components/DocsDropdown";
+export { DocToc } from "./components/DocToc";
+export {
+	clearGitHubToken,
+	GitHubAuthButton,
+	getGitHubToken,
+	setGitHubToken,
+} from "./components/GitHubAuth";
+export { GitHubStats } from "./components/GitHubStats";
+export { Head } from "./components/Head";
+export { LocaleDropdown } from "./components/LocaleDropdown";
+export { PageActions } from "./components/PageActions";
+export { RelatedDocs } from "./components/RelatedDocs";
+export { ScrollProgress } from "./components/ScrollProgress";
+export {
+	SearchPalette,
+	searchOpen,
+	setSearchOpen,
+} from "./components/SearchPalette";
+export { SidebarNav } from "./components/SidebarNav";
+export {
+	SkeletonBlock,
+	SkeletonPage,
+	SkeletonText,
+} from "./components/Skeleton";
+export { ThemeToggle } from "./components/ThemeToggle";
+export { TopNav } from "./components/TopNav";
+export { VersionDropdown } from "./components/VersionDropdown";
+export type {
+	ApiCollection,
+	DocsAppConfig,
+	DocsAppFeatures,
+	DocsVersion,
+	GitHubConfig,
+	GitHubOAuthConfig,
+	HomeConfig,
+	HomeFeature,
+	I18nConfig,
+	LocaleInfo,
+	MarkdownConfig,
+	PluginInfo,
+	ShowcaseInfo,
+	VersionsConfig,
+} from "./config";
+export type { DirMeta, StaticSourceOptions } from "./content";
+export {
+	createCompositeDataSource,
+	createRemoteDataSource,
+	createStaticDataSource,
+	parseFrontmatter,
+	queryDocs,
+	relatedDocs,
+} from "./content";
+export { DocsProvider, useDocs } from "./context";
+export { createDocsList, useCollections } from "./data";
+export type {
+	BranchInfo,
+	CommitInfo,
+	Contributor,
+	IssueInfo,
+	MilestoneInfo,
+	ReleaseInfo,
+	RepoStats,
+	TagInfo,
+} from "./github";
+export {
+	fetchBranches,
+	fetchCommits,
+	fetchContributors,
+	fetchIssues,
+	fetchLatestCommit,
+	fetchMilestones,
+	fetchReleases,
+	fetchRepoStats,
+	fetchTags,
+	GitHubFetchError,
+	githubApiUrl,
+	shieldsBadge,
+} from "./github";
+// Pages & layouts
+export { DocsLayout } from "./layouts/DocsLayout";
+export { AnalyticsPage } from "./pages/AnalyticsPage";
+export { ApiDiffPage } from "./pages/ApiDiffPage";
+export { ApiEndpointPage } from "./pages/ApiEndpointPage";
+export { ChangelogPage } from "./pages/ChangelogPage";
+export { CollectionPage } from "./pages/CollectionPage";
+export { CommunityPage } from "./pages/CommunityPage";
+export { CreatePage } from "./pages/CreatePage";
+export { DocPage } from "./pages/DocPage";
+export { HomePage } from "./pages/HomePage";
+export { IssuesPage } from "./pages/IssuesPage";
+export { OAuthCallbackPage } from "./pages/OAuthCallbackPage";
+export { PluginsPage } from "./pages/PluginsPage";
+export { ShowcasePage } from "./pages/ShowcasePage";
+export { setupPwa } from "./pwa";
+export { createDocsRouter } from "./router";
+export type { SeoInput } from "./seo";
+export {
+	generateAtom,
+	generateJsonFeed,
+	generateLlmsTxt,
+	generateRobots,
+	generateRss,
+	generateSitemap,
+} from "./seo";
+export {
+	type AccentSetting,
+	accentIndex,
+	DAILY_ACCENTS,
+	type DailyAccent,
+	initTheme,
+	setAccent,
+	useAccent,
+	useTheme,
+} from "./theme";
+export type {
+	ApiEndpoint,
+	ApiParameter,
+	AskInput,
+	AskResult,
+	CliArg,
+	CliEndpoint,
+	CollectionMeta,
+	DocContent,
+	DocEntry,
+	DocsDataSource,
+	GraphQlEndpoint,
+	HttpMethod,
+	SearchResult,
+} from "./types";

package/src/runtime/layouts/DocsLayout.tsx

@@ -0,0 +1,144 @@
+import {
+	Outlet,
+	useLocation,
+	useNavigate,
+	useParams,
+} from "@tanstack/solid-router";
+import { createEffect, createSignal, onCleanup, onMount, Show } from "solid-js";
+import { BackToTop } from "../components/BackToTop";
+import { Banner } from "../components/Banner";
+import { Footer } from "../components/Footer";
+import { Head } from "../components/Head";
+import { MobileBottomNav } from "../components/MobileBottomNav";
+import { ScrollProgress } from "../components/ScrollProgress";
+import { SearchPalette, setSearchOpen } from "../components/SearchPalette";
+import { SidebarNav } from "../components/SidebarNav";
+import { TopNav } from "../components/TopNav";
+import { createDocsList } from "../data";
+
+export function DocsLayout() {
+	const [navOpen, setNavOpen] = createSignal(false);
+	const params = useParams({ strict: false });
+	const inCollection = () => !!params().collection;
+	const navigate = useNavigate();
+	const [docs] = createDocsList(() => params().collection ?? "");
+	const location = useLocation();
+	let mainRef: HTMLElement | undefined;
+
+	createEffect(() => {
+		location().pathname;
+		const el = mainRef;
+		if (!el) return;
+		el.classList.remove("docs-page-enter");
+		void el.offsetWidth;
+		el.classList.add("docs-page-enter");
+	});
+
+	const focusable = (target: EventTarget | null) => {
+		if (!(target instanceof HTMLElement)) return false;
+		const tag = target.tagName.toLowerCase();
+		return (
+			tag === "input" ||
+			tag === "textarea" ||
+			tag === "select" ||
+			target.isContentEditable
+		);
+	};
+
+	const docsPath = () => {
+		const list = docs() ?? [];
+		const id = params().docId;
+		if (!id) return null;
+		const idx = list.findIndex((d) => d.id === id);
+		if (idx < 0) return null;
+		return { list, idx };
+	};
+
+	const goDoc = (nextIdx: number) => {
+		const p = docsPath();
+		const collection = params().collection;
+		if (!p || !collection) return;
+		const next = p.list[nextIdx];
+		if (!next) return;
+		navigate({
+			to: "/$collection/$docId",
+			params: { collection, docId: next.id },
+		});
+	};
+
+	const onKey = (e: KeyboardEvent) => {
+		if (focusable(e.target)) {
+			if (e.key === "Escape") {
+				(e.target as HTMLElement).blur();
+			}
+			return;
+		}
+
+		if (e.key === "/") {
+			e.preventDefault();
+			setSearchOpen(true);
+			return;
+		}
+
+		if ((e.ctrlKey || e.metaKey) && e.key.toLowerCase() === "k") {
+			e.preventDefault();
+			setSearchOpen((v) => !v);
+			return;
+		}
+
+		if (e.key === "j" || e.key === "J") {
+			e.preventDefault();
+			const p = docsPath();
+			if (p) goDoc(Math.min(p.idx + 1, p.list.length - 1));
+			return;
+		}
+
+		if (e.key === "k" || e.key === "K") {
+			e.preventDefault();
+			const p = docsPath();
+			if (p) goDoc(Math.max(p.idx - 1, 0));
+			return;
+		}
+
+		if (e.key === "Escape") {
+			setSearchOpen(false);
+		}
+	};
+
+	onMount(() => document.addEventListener("keydown", onKey));
+	onCleanup(() => document.removeEventListener("keydown", onKey));
+
+	return (
+		<div class="min-h-screen flex flex-col bg-background text-foreground">
+			<Head />
+			<ScrollProgress />
+			<Banner />
+			<TopNav onMenuToggle={() => setNavOpen(!navOpen())} />
+			<div class="flex flex-1 min-h-0">
+				<Show when={inCollection()}>
+					<SidebarNav open={navOpen()} onNavigate={() => setNavOpen(false)} />
+				</Show>
+				<Show when={navOpen()}>
+					<button
+						type="button"
+						aria-label="Close sidebar"
+						class="fixed inset-0 top-[var(--docs-banner-height,0px)] z-20 bg-overlay lg:hidden cursor-default"
+						onClick={() => setNavOpen(false)}
+					/>
+				</Show>
+				<main
+					ref={(el) => {
+						mainRef = el;
+					}}
+					class={`flex-1 min-w-0 pb-16 lg:pb-0 ${inCollection() ? "lg:pl-72" : ""}`}
+				>
+					<Outlet />
+				</main>
+			</div>
+			<MobileBottomNav onMenuToggle={() => setNavOpen(!navOpen())} />
+			<Footer />
+			<SearchPalette />
+			<BackToTop />
+		</div>
+	);
+}