Content API

import { getDoc } from "fromsrc";

const doc = await getDoc("docs", ["components", "button"]);
// loads docs/components/button.mdx

if (doc) {
  console.log(doc.title);
  console.log(doc.content);
}

interface Doc {
  slug: string; // "components/button"
  title: string; // from frontmatter
  description?: string;
  order?: number;
  content: string; // raw mdx content
  data: Record<string, unknown>; // all frontmatter
}

import { getAllDocs } from "fromsrc";

const docs = await getAllDocs("docs");

docs.forEach((doc) => {
  console.log(doc.slug, doc.title);
});

interface DocMeta {
  slug: string;
  title: string;
  description?: string;
  order?: number;
}

import { getNavigation } from "fromsrc";

const nav = await getNavigation("docs");
// [
//   { title: "documentation", items: [...] },
//   { title: "api", items: [...] },
//   { title: "manual installation", items: [...] },
// ]

import { defineContent, extendSchema, z } from "fromsrc";

const content = defineContent({
  dir: "docs",
  schema: extendSchema({
    author: z.string().optional(),
    tags: z.array(z.string()).optional(),
  }),
});

const doc = await content.getDoc(["installation"]);
// doc.data.author is typed

interface ContentAPI {
  getDoc: (slug: string[]) => Promise<Doc | null>;
  getAllDocs: () => Promise<DocMeta[]>;
  getNavigation: () => Promise<Section[]>;
  schema: ZodObject;
}

const baseSchema = z.object({
  title: z.string(),
  description: z.string().optional(),
  order: z.number().optional(),
});

import { extendSchema, z } from "fromsrc";

const schema = extendSchema({
  author: z.string(),
  publishedAt: z.string().datetime(),
});

import { defineSchema, z } from "fromsrc";

const schema = defineSchema(
  z.object({
    name: z.string(),
    version: z.string(),
  })
);