tickerlog docs

The source of docs.tickerlog.io, built with VitePress.

npm install
npm run dev      # http://localhost:5199
npm run build    # docs/.vitepress/dist
npm run preview

Layout

Everything the site is made of lives in docs/:

Path	What it is
docs/**/*.md	The pages. Plain Markdown, edited directly.
docs/index.md	Landing page.
docs/.vitepress/config.mjs	Navigation, sidebar, navbar, footer, head tags.
docs/.vitepress/theme/style.css	The palette, fonts and layout overrides — a copy of the marketing site's theme.
docs/.vitepress/theme/components/	Card, CardGroup, SectionLabel and DocFooter.
docs/public/	favicon.svg — the shared artwork, byte for byte the file the app, the marketing site and the admin panel serve. The wordmark beside it in the navbar is type (siteTitle, mono 700), not an image.

Adding a page means creating the .md file and adding it to the sidebar in config.mjs; nothing else generates or rewrites the content.

Give every page a title in the frontmatter and an # h1 in the body — VitePress does not print the frontmatter title on the page, so without the heading the page opens on its first paragraph.

Card and CardGroup are Vue components registered globally, so they work inside Markdown without an import. Card takes title, href, horizontal and an optional icon — the icons are listed in Card.vue, each on a tinted hue tile, and an unrecognised name renders no icon rather than failing the build.

Worth knowing

• The design matches tickerlog.io ("Grotesk over mono" on the Foxe Mono Kit palette): Space Grotesk for prose and headings, Inconsolata for code, micro-labels and the wordmark, no brand accent, links in ink and never underlined, dark by default. Every colour in style.css is a hand-kept copy of the site's global.css — nothing propagates.
• Fonts are self-hosted through fontsource and bundled by Vite, so the docs make no third-party request. The privacy policy on tickerlog.io says so; adding a webfont link back is a legal change.
• VitePress's own footer never renders here (it is hidden on sidebar pages, which is every page), so the copyright line is DocFooter.vue in the doc-after slot.
• Search is a local index built at compile time — no service, no network call, no key.
• No telemetry. Nothing writes to localStorage except VitePress's own colour-scheme preference, which is necessary rather than analytical.
• No "copy page as Markdown" or LLM hand-off menu. If it is wanted, a llms.txt or a per-page copy button has to be built.

Deployment — Cloudflare Workers

Pushing to main deploys. .github/workflows/deploy.yml builds and uploads on every push, and can be re-run by hand from the Actions tab. Deploying locally is the fallback, for when the site has to go out without a commit:

npm run deploy   # builds, then uploads docs/.vitepress/dist

The workflow needs one repository secret, CLOUDFLARE_API_TOKEN — created at Cloudflare Dashboard → My Profile → API Tokens → Create Token, from the Edit Cloudflare Workers template, scoped to the TickerLog account. Nothing else is secret: the account id is in the workflow file, and there are no build time variables. Rotating the token is a Dashboard change plus a secret update, with no code change.

wrangler.toml is the source of truth, including the docs.tickerlog.io custom domain — a route set in the Dashboard alone is dropped by the next deploy. There is no main and no Worker script: an assets-only Worker is served straight from Cloudflare's asset storage, so no request is billed as an invocation.

Two settings there are load-bearing rather than taste:

• html_handling = "drop-trailing-slash" matches cleanUrls: true in config.mjs. The build writes flat start/first-trade.html files and links to them without the extension, so /start/first-trade must serve the file and /start/first-trade/ must redirect to it. Cloudflare's default serves both, which is two URLs for one page.
• not_found_handling = "404-page" serves the themed 404.html. Without it an unknown path gets Cloudflare's generic 404, with no nav and no way back in.

Nothing runs server-side, so a rollback is a redeploy of the previous build. Note the free plan permits this: Cloudflare has no non-commercial restriction on static assets, where Vercel's Hobby plan does and would rule out a paid product's documentation.

---

The docs rule from the main repo still applies: what the docs claim is what the app does, and no page walks through connecting a broker until sync ships.