README

Astro Modular

A flexible blog theme designed for Obsidian users.

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

Quick Start

Prerequisites

Node.js 18.20.8
pnpm 7.1.0 or npm 9.6.5

While this theme works great with any markdown editor, it’s specifically optimized for Obsidian use. See the

Setup

Install pnpm (if you don’t have it):
```
npm install -g pnpm
```
Install dependencies:
```
pnpm install
```
Preview:
```
pnpm dev
```
Your blog will be available at http://localhost:5000
Build for production:
```
pnpm build
```

Configuration

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

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!