Astro Modular

A flexible blog theme designed for Obsidian users.

Use Obsidian as a CMS

Stats

Status

Tech Stack

Why Astro Modular?

• Obsidian As A CMS: Works with Obsidian out of the box (built upon Obsidian Astro Suite), write and publish instantly
• Highly Customizable: Every feature can be enabled/disabled independently
• Performance-Focused: Assets are highly optimized for lightning-fast loading
• SEO-Ready: Automatic sitemap, RSS feed, and Open Graph image generation

Features

• Custom Themes
• Feature Toggle Control
• Dark/Light Mode
• Search & Command Palette
• Wikilinks & Linked Mentions
• Obsidian-Style Callouts
• Obsidian Embeds Files
• Folder-Based Posts
• Multiple Content Types
• Image Optimization
• Automatic Feed Generation
• Table of Contents
• Smooth Scroll & Page Transitions
• Image Gallery & Lightbox
• Reading Time & Word Count
• Tagging
• Graph View
• Mermaid Diagrams
• LaTeX & Math Rendering
• Custom Typography
• Profile Picture
• Comments

Quick Start

Prerequisites

• Node.js 18.20.8
• pnpm 7.1.0 or npm 9.6.5

Setup

1. Install pnpm (if you don’t have it):

   npm install -g pnpm

2. Install dependencies:

   pnpm install

3. Preview:

   pnpm dev

   Your blog will be available at http://localhost:5000

4. Build for production:

   pnpm build

Configuration

Edit src/config.ts to customize your site - change the theme, enable/disable features, and configure all settings.

Deployment

Set your deployment platform once in src/config.ts under deployment.platform (“netlify”, “vercel”, or “github-pages”). The build process automatically generates the correct configuration files for your chosen platform - no environment variables needed!

Documentation

For detailed guides, see the included blog posts:

• Getting Started - complete setup and workflow guide
• Formatting Reference - comprehensive formatting reference
• Astro Suite Vault Guide - Obsidian vault walkthrough
• Obsidian Embeds Demo - Obsidian embed examples

For AI Agents & Developers: See AGENTS.md for comprehensive technical documentation.

Star History

Acknowledgments

Spaceship Astro theme for the graph view functionality upon which this theme’s is based.

Contributing

This is an open-source project. Feel free to submit feature requests, report bugs, or contribute improvements.

License

MIT site license.