The OFKM Technologies site: open-source, self-hosted projects and the documentation that goes with them.

Every page is pre-rendered at build time — the site ships as static HTML with no client-side data fetching.

pnpm install

pnpm dev

The dev server runs at http://localhost:3000.

src/routeTree.gen.ts is generated by the TanStack Router Vite plugin and is gitignored, so it only exists after pnpm dev or pnpm build has run. Type checking depends on it — without it every createFileRoute call fails to resolve and the errors cascade. That is why pnpm build runs tsc --noEmit itself, after generation, and why CI builds rather than typechecking first. On a fresh clone, run pnpm build before pnpm typecheck.

src/
  routes/          file-based routes (the URL structure lives here)
  components/      site chrome + ui primitives
  config/          content: projects, navigation, site metadata
  content/docs/    project documentation, as markdown
  lib/             theme, the docs engine, helpers
  styles/app.css   design tokens and the whole visual system

Add an entry to src/config/projects.ts. It appears on the home page and /projects, gets its own /projects/<slug> page, and shows up in the sidebar — all derived from that one file. Optional fields (highlights, version, license) add the corresponding sections to the detail page when present.

Drop markdown files into src/content/docs/<project-slug>/, where the slug matches a key in src/config/projects.ts:

src/content/docs/tally/
  index.md          -> /docs/tally
  installation.md   -> /docs/tally/installation
  usage.md          -> /docs/tally/usage

Each file starts with frontmatter:

---
title: Usage
description: Counting a directory, specific paths, and per-directory totals.
order: 2
---

title is required; description becomes the meta description; order sorts the page rail ascending (index.md always leads, pages without an order sort last). That is the entire contract — routing, the page rail, the on-page contents list, prev/next links, the /docs listing and prerendering are all derived from the files on disk. There is nothing to register.

Markdown is rendered by markdown-it with Shiki for code blocks, both running inside a server function — so neither the parser, the highlighter, nor the raw markdown ends up in the client bundle. The browser receives finished HTML.

A project with a docsUrl but no markdown directory is listed on /docs as an external link instead, so the page covers everything either way.

The visual language is documented where it is enforced — src/styles/app.css. In short: a near-neutral greyscale, hairline borders, soft rounded surfaces, Montserrat for display headings, and blue reserved for whatever is interactive or current. Both themes are first-class; dark is the default.

Two rules keep it coherent:

• Colour means something. Blue marks the current page, the primary action, and links. Green / amber / violet are reserved for status. Everything else is greyscale.
• One container primitive. The .card class in app.css is the only surface treatment; components compose it rather than inventing their own borders and radii.

MIT