Obsidian-flavored markdown, rendered straight from your Git repo

// syntax

The Obsidian conventions, not a subset of them

Markdown that reads correctly in your editor renders correctly here. Wikilinks resolve with aliases and heading anchors, so [[CONTRIBUTING#Auth Flow]] lands on the heading rather than the top of the page. Callouts carry icons and colors and nest inside each other. Mermaid flowcharts, sequence diagrams and ERDs render inline. KaTeX handles inline and block math.

# Auth

Rotation follows [[CONTRIBUTING#Auth Flow]], and the older
handshake is documented at [[legacy-auth|the v1 flow]].

> [!warning] Replay window
> Refresh tokens rotate on use — a replayed token is dead
> on arrival. See $t_{expiry} = t_{issue} + 900s$.

```mermaid
flowchart LR
  A[client] --> B{token valid?}
  B -->|yes| C[rotate + issue]
  B -->|no| D[401]
```

Rendered directly from GitHub repositories. GitLab and self-hosted git support are coming soon.

// discovery

Structure comes from a convention, not a config file

gitian scans for docs/ and .docs/ directories at any level and merges every one of them into a single flat map. There is no hierarchy to maintain and no vault to switch between. The pairing rule is one line long: name a file after the source it documents, and the two render together.

repo/
├─ src/
│  ├─ auth.ts
│  └─ docs/
│     └─ auth.ts.md   ← documents auth.ts
├─ services/
│  └─ .docs/
│     └─ sync.md       ← a standalone page
└─ .gitian/
   └─ config.yaml     ← optional — safe defaults without it

A paired source file renders as a tabbed view: a Docs tab with the rendered markdown, a Source tab with syntax-highlighted code. Click a line number to select it; right-click to copy a gitian link, a GitHub permalink, or the source line itself. The repo dashboard gives the whole repository the same treatment: annotation breakdowns, language stats, recent commits, releases, and documentation, loading progressively.

No config file at all is a supported state, not a degraded one: absent .gitian/config.yaml, gitian falls back to safe defaults.

// the argument

A vault that lives in the repo can't drift from it

Documentation kept anywhere else is documentation kept somewhere that doesn't know when your code changed. In the repo, the doc travels in the same commit, on the same branch, through the same review as the change it describes. A reviewer sees both, and a rename moves both.

drift

→ impossible to hide in review the doc is in the diff

ghost pages

→ deleted with their source — nothing outlives the module it described

context

→ written where it was understood not reconstructed later in a wiki

There's nothing to export, sync, or host separately. Your documentation lives in your repo and updates when your code does.

// access

Point it at a repository

Public repositories browse without signing in at all. Explore the demo repository to see the rendering before you connect anything. For your own repos, sign in and install the GitHub App: it installs on specific repositories or organizations rather than requesting broad OAuth scopes, and it deep-links to files and lines.

Plugins for VS Code, Zed, and Obsidian are coming soon.

// questions

Questions people actually ask

// how this page is found

This route's own index plan

This is the strongest exact-match wedge in the documentation half of the product, because the thing it describes is unusually specific: Obsidian-flavored syntax, rendered from a Git repository, and it needs no build step. That phrase combination has real search volume and very few pages that honestly satisfy it.