Skip to content

fluxon-lang/docs

Repository files navigation

Fluxon Docs

The documentation site for Fluxon — a backend programming language AI agents write well. Lives at docs.fluxon-lang.com.

Built with Fumadocs (Next.js + MDX). Content is authored as MDX in content/docs/.

Human + agent friendly

Every page is served two ways, chosen automatically by the request:

  • Browsers get the styled HTML page.
  • Agents / curl / fetch tools get the raw Markdown — no flags, no query params. A human can copy any page URL into an agent and it just works (the User-Agent decides; see proxy.ts).

Also exposed for LLMs:

  • /<page>.md — raw Markdown of any page (e.g. /docs/batteries/http.md)
  • /llms.txt — index of every page
  • /llms-full.txt — every page concatenated into one document
  • /fluxon-agent.md — the compact, canonical language spec

Develop

bun install
bun dev          # http://localhost:3000  → redirects to /docs

Add or edit pages under content/docs/. Sidebar order lives in the meta.json files. Fluxon code blocks use the fx language tag and are highlighted with a custom Shiki grammar + theme (lib/fluxon-grammar.ts, lib/fluxon-theme.ts) that matches the marketing site's warm-paper palette.

Deploy (Cloudflare Workers)

Deployed with the OpenNext Cloudflare adapter (Fumadocs needs the Node.js runtime, not Edge).

bun run preview   # build + run locally in the Workers runtime
bun run deploy    # build + deploy to Cloudflare

Bind docs.fluxon-lang.com to the fluxon-docs Worker in the Cloudflare dashboard (or add a routes entry in wrangler.jsonc).

About

Documentation site for Fluxon — docs.fluxon-lang.com. Human-readable HTML + automatic raw Markdown for AI agents.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors