davidvkimball/astro-modular
davidvkimball/astro-modular has 238 GitHub stars and 43 forks. GitHot measured 0 stars in 24 hours. Last checked 2026-11-20 13:17 UTC. Last push 2026-11-15.
What you can do
- Feature Toggle Control
- Dark/Light Mode
- Search & Command Palette
- Wikilinks & Linked Mentions
Progression mesurée des étoiles
- in 24h
- 0
- in 7 days
- Historique en cours
- in 15 days
- Historique en cours
- in 1 month
- Historique en cours
Variations nettes sur des périodes qui se chevauchent, pas des totaux quotidiens. Les mesures absentes restent vides. Les étoiles indiquent l’intérêt, pas la qualité.
À propos
A flexible Astro blog theme designed for Obsidian users.
Outils de développementREADME.md
OriginalAstro Modular
A flexible Astro blog theme designed for Obsidian users.
Made with Vault CMS
Use Obsidian as a CMS with Vault CMS.
Rather not use Obsidian? Zeku is a standalone writing app for Astro sites from the same developer, and it opens this theme with its settings as a form.
Stats
Status
Tech Stack
Why Astro Modular?
- Obsidian As A CMS: Works with Obsidian out of the box (built upon Vault CMS), 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
[!IMPORTANT] Vault CMS is already included. Astro Modular ships with Vault CMS and every Obsidian plugin it uses, preconfigured in
src/content/.obsidian/. Don't install Vault CMS separately: its installer copies its own.obsidianand_basesfolders over the ones bundled here.
What you need
- Obsidian to write.
- Git and a GitHub account to publish. The setup wizard in Obsidian creates the GitHub repository for you.
- A host such as Netlify, Vercel, or Cloudflare. The host builds your site from GitHub, so publishing needs nothing else installed on your computer.
- Optional: Node.js 24.13.0+ and pnpm 10.29.3+. You only need these to preview the site on your own computer or to use the command-line install below.
Get the code
Pick whichever option suits you. They all give you the same theme.
Option 1: Download the ZIP (no command line)
- Open the latest release.
- Under Assets, download Source code (zip), then extract it wherever you want your site's project folder to live.
- In Obsidian, select Open folder as vault and choose the
src/contentfolder inside the extracted project. - When Obsidian asks, trust the author and enable plugins. The setup wizard then walks you through your site settings, GitHub, and deployment.
Option 2: Command line
Requires Node.js and pnpm.
pnpm create astro-modular my-blog
This downloads the latest release, removes dev-only files, and installs dependencies. Then open my-blog/src/content as a vault in Obsidian, as in step 3 above.
Option 3: GitHub template
- Click the "Use this template" button on the repository page
- Select "Create a new repository"
- Choose your repository name and settings
- Click "Create repository from template"
- Clone your new repository:
git clone https://github.com/your-username/your-repo-name.git cd your-repo-name
[!IMPORTANT] After cloning, confirm that
src/content/.obsidian/exists and contains apluginsfolder. The Obsidian vault lives in a dotfolder, and the template button does not always copy dotfolders. If it is missing or empty, the setup wizard will have no plugins to configure, and new notes will be created without frontmatter.Dotfolders are hidden by default, so check with
ls -a src/content(macOS and Linux) ordir /a src\content(Windows). Options 1 and 2 avoid this entirely.
[!NOTE] While this theme works great with any markdown editor, it's specifically optimized for Obsidian use. See the Vault CMS Guide for Obsidian-specific features.
Preview on your computer (optional)
Your host builds and publishes the site, so this step is only for seeing changes before you publish. It requires Node.js and pnpm. Run these commands from the project folder (the one that contains package.json):
Install pnpm (if you don't have it):
npm install -g pnpmInstall dependencies:
pnpm installPreview:
pnpm devYour blog will be available at
http://localhost:5000Build for production:
pnpm build
Updating the theme
To pull the latest theme release (framework files, Astro, config) while keeping your content and assets:
pnpm run update
This downloads the latest release from GitHub, replaces framework files, restores your src/content and profile/favicon assets, then runs pnpm install. After updating, open Obsidian and use Astro Modular Settings → Apply all settings so your saved settings are written to the new config.ts if needed.
Configuration
Edit src/config.ts to customize your site - change the theme, enable/disable features, and configure all settings. In Obsidian, the Astro Modular Settings plugin edits the same file, and so does the theme settings screen in Zeku.
Deployment
Set your deployment platform once in src/config.ts under deployment.platform ("netlify", "vercel", "github-pages", or "cloudflare-workers"). 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
- Vault CMS 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.
ogImage.click to generate the open graph image used for this theme.
Contributing
This is an open-source project. Feel free to submit feature requests, report bugs, or contribute improvements.
If you are contributing code back to the theme itself, please fork the repository and submit a Pull Request. Do not fork the repository if you are just building your own site from this template.