Skip to content

A set of Obsidian vaults to plug into your Astro website to write and publish easily.

License

Notifications You must be signed in to change notification settings

davidvkimball/obsidian-astro-suite

Repository files navigation

Astro Suite for Obsidian

A set of preconfigured Obsidian vaults to publish Astro blog posts easily.

astro-composer-suite-for-obsidian

Video Guide

📺 Astro Suite for Obsidian Video Guide

Features

  • Easy integration into Astro website projects
  • Preconfigured plugins, hotkeys and settings optimized for Astro workflows
  • CMS-like homepage using Obsidian Bases
  • Default, Minimal, and Docs options optimized for different Astro themes
  • Optional instant-publish option via the Git plugin
astro-suite-preview

Note

To see an Astro Suite Obsidian vault combined with an Astro site specifically designed with it in mind, check out my theme Astro Modular.

Installation Guide

  1. Clone or install your Astro theme of choice.
  2. Clone or download a zip of this repo.
  3. Open the folder of the version you want (Default, Minimal, or Docs)
  4. Copy the contents of that folder into the proper directory depending on your theme (see below)
  5. Open Obsidian and select the "Open folder as vault" option, and select the folder with the .obsidian folder in it.

Vaults

Each vault has preconfigured settings and plugins that match its intended use case / Astro theme.

Default

Optimized for Slate blog, but the most general-purpose option. Copy folder contents in the src/content folder.

Minimal

Optimized for Chiri, a far more opinionated vault prioritizing visual minimalism. Copy folder contents in the src/content/posts folder.

Docs

Optimized for Starlight, Astro's starter documentation theme. Copy folder contents in the src/content folder.

Recommended .gitignore

Add the following to your Astro project's .gitignore file:

# Obsidian workspace files
**/.obsidian/workspace.json
**/.obsidian/workspace-mobile.json

This prevents conflicts between multiple devices.

About

A set of Obsidian vaults to plug into your Astro website to write and publish easily.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

  •  

Packages

No packages published