Skip to content

Astro Modular

Astro Modular is a free, open-source Astro theme built specifically for Obsidian users. It includes a dedicated settings plugin so you can configure your site from inside Obsidian.

  • 17 built-in color themes + custom theme generation
  • Command palette (Ctrl+K) for search, navigation, and quick actions
  • Page transitions (Swup.js)
  • Local knowledge graph with D3
  • Linked mentions (backlinks)
  • Profile card with customizable placement
  • Automatic OG image generation
  • RSS feed and sitemap
  • Multiple deployment platform configs (Netlify, Vercel, Cloudflare, GitHub Pages)
  • Posts with tags, cover images, reading time, word count, and drafts
  • Pages for static content
  • Projects with status badges and links
  • Docs with category grouping
  • Full Obsidian markdown parity: wikilinks, callouts, highlights, embeds, image sizing
  • LaTeX/KaTeX math rendering
  • Mermaid diagrams
  • Image grids with lightbox
  • Code blocks with syntax highlighting
  • Giscus comments (optional)
  • Dedicated Obsidian plugin that controls all site configuration
  • Theme switching, typography, layout, and feature toggles from a UI
  • Custom theme generation (extract colors from your Obsidian theme)
  • No config.ts editing required
  1. Clone or download the Astro Modular repo
  2. Open the src/content folder as a vault in Obsidian
  3. Vault CMS and the settings plugin are already bundled
  4. Start writing
PropertyTypeDescription
titlestringPost title
descriptionstringShort description for SEO and previews
datedatePublication date
tagsstring[]Tags for categorization
draftbooleanHide from production builds
imagestringCover image path
imageAltstringCover image alt text
imageOGbooleanUse cover image as OG image
hideCoverImagebooleanHide cover image on the post page
hideTOCbooleanHide table of contents
targetKeywordstringSEO target keyword

MIT. Free for personal and commercial use.