title: Getting Started date: 2025-09-06 description: Quick start guide for Astro Modular - get your blog running in minutes. This will walk you through Vault CMS and the particulars of this theme. tags: - tutorial - setup - quick-start - astro - blog image: "[[attachments/sunset.webp]]" imageAlt: Sunset skyline. imageOG: true hideCoverImage: false hideTOC: false draft: true
Welcome to Astro Modular! This quick start guide will get your blog running in minutes. Choose your preferred workflow below.
You'll need: - Node.js 18+ - pnpm (recommended) or npm
# 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
Perfect! Astro Modular is designed specifically for Obsidian users.
Quick Start:
1. Open folder as vault: Navigate to src/content/ in Obsidian
2. Trust the author and enable the preconfigured plugins
3. Use the Astro Modular Settings wizard to configure your theme and preferences
4. 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]] and markdown links work perfectly
- Obsidian-specific features: callouts, highlighting, and more display beautifully
- Preconfigured plugins & hotkeys: all optimized for blogging
Next Steps: - Read the Obsidian 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
No problem! You can still use Astro Modular with any editor.
Quick Start:
1. Edit src/config.ts to customize your site settings
2. Create content in src/content/posts/ using standard markdown
3. Deploy when ready
Next Steps:
- Read the setup guide for detailed configuration
- Explore the reference guide for markdown features
- Customize your theme and layout in src/config.ts
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',
}
Switch between Oxygen, Minimal, Nord, Dracula, and more. Use Ctrl+K → "Change Theme" for instant switching.
Press Ctrl+K for instant navigation, search, and theme switching.
Optimized for performance with automatic image optimization and lazy loading.
[[Post Title]][Post Title](posts/post-slug)src/content/ in Obsidiansrc/config.tsYour modular Astro blog is ready to go!