Getting Started

Welcome to Astro Modular! This quick start guide will get your blog running in minutes. Choose your preferred workflow below.

Prerequisites & Installation

You’ll need:

Node.js 18+
pnpm (recommended) or npm

Quick Setup

# Install pnpm
npm install -g pnpm

# Install dependencies
pnpm install

# Preview
pnpm dev # or pnpm preview
# Available at http://localhost:5000

# Build for production
pnpm build

Choose Your Workflow

Using Obsidian?

Perfect! Astro Modular is designed specifically for Obsidian users.

Quick Start:

Open the included vault: Navigate to src/content/ in Obsidian
Trust the author and enable the preconfigured plugins
Use the Astro Modular Settings plugin to configure your theme and preferences
Start writing with the included templates and hotkeys

What you get:

Seamless publishing - write in Obsidian, publish to your blog with git
Versatile internal linking support - [[Wikilinks]] work perfectly
Obsidian-specific features - > [!note] and more display beautifully
Preconfigured plugins & hotkeys - all optimized for blogging

Next Steps:

Read the Astro Suite Vault Guide for detailed setup
Use the Astro Modular Settings plugin to customize your theme and preferences
Start writing your first post with the included templates

📝 Not Using Obsidian?

No problem! You can still use Astro Modular with any editor.

Quick Start:

Edit src/config.ts to customize your site settings
Create content in src/content/posts/ using standard markdown
Use the command palette (Ctrl+K) for navigation and theme switching
Deploy when ready

What you get:

Full customization - complete control over themes, fonts, and layout
Command palette - instant navigation and search
Multiple content types - posts, pages, projects, and documentation
Modern features - dark mode, responsive design, SEO optimization

Next Steps:

Read the Complete Setup Guide for detailed configuration
Explore the Formatting Reference for markdown features
Customize your theme and layout in src/config.ts

Essential Configuration

Update these core settings in src/config.ts:

export const siteConfig = {
  site: 'https://yourdomain.com',
  title: 'Your Blog Title',
  description: 'Your blog description',
  author: 'Your Name',
  language: 'en',
}