All Docs
Axis

Getting Started

Last modified

arrow

Installation

  1. Clone or download Axis.
  2. Run pnpm install.
  3. Run pnpm dev to start the dev server.

Configuration

Axis is configured from inside Obsidian via the Axis Settings plugin, which is bundled with Axis (no install needed). Open the src/content/ folder as an Obsidian vault and access Axis Settings one of two ways:

  • Rocket icon in the left sidebar ribbon, next to the gear icon. If you don’t see it, hover over the ribbon area to reveal it. UI Tweaker may have it hidden by default.
  • Settings → Community plugins → Axis Settings as a fallback (community plugins are already enabled in the bundled vault).

Use Axis Settings to configure theme, navigation, content types, fonts, homepage layout, and everything else. Changes are written to src/config.ts for you.

If you prefer to edit by hand, all site settings are in src/config.ts; see the inline comments for each option.

Adding content

  • Posts — src/content/posts/<slug>/index.md (one folder per post)
  • Pages — src/content/pages/<slug>/index.md (one folder per page)
  • Projects — src/content/projects/<slug>/index.md (one folder per project)
  • Docs — src/content/docs/<slug>/index.md (one folder per doc)