Spaceship

Spaceship is an Astro and TailwindCSS theme that converts an Obsidian vault into a fast, static website while preserving Obsidian-specific features like wiki-links, image embeds, backlinks, and YAML frontmatter.

What is Spaceship?

Spaceship is an open-source (MIT) Astro theme created by aitorllj93 that takes your Obsidian vault — a folder of Markdown notes using Obsidian syntax — as its input and produces a static website as output. It runs on Astro's static site generator, styled with TailwindCSS, and is configured through files like website.config.mjs, styles/global.css, content.config.ts, and the content directory itself. The theme is designed for publishing digital gardens, second brains, research notes, and personal wikis without requiring manual conversion of Obsidian links or embeds.

Key Features

• Obsidian link and image resolution — Supports [[wiki-links]] and embeds like ![[image.png]] natively, so no manual conversion is needed.
• Frontmatter publishing controls — YAML frontmatter options control visibility, title, description, and tags per note.
• Tree navigation bar — A collapsible file tree mirrors the vault structure for navigation.
• Auto-generated table of contents — Each page gets a ToC based on headings.
• Links and backlinks — Outgoing links and backlinks display at the bottom of each note.
• Plugin support — Integrates with pixel-banner for covers, obsidian-spoilers, obsidian-timeline, and obsidian-nav-weight for sorting.
• Built with Astro and TailwindCSS — Static site generation with utility-first CSS; markdown rendering includes code highlighting, optional math support, and responsive design.

Who is it for?

• Digital gardeners — Publish a second brain or digital garden with minimal setup.
• Researchers and students — Share research notes and knowledge bases while keeping internal wiki-links and backlinks intact.
• Personal wiki creators — Build a personal wiki with tree navigation and backlinks.
• Course authors and creative professionals — Document coursework or creative projects with embedded images, timelines, and auto-generated ToC.

What can you do with Spaceship?

• Digital gardeners: Publish your Obsidian vault as a public digital garden with one command, preserving wiki-links and embeds.
• Researchers: Share research notes and a knowledge base with backlinks and a table of contents for easy navigation.
• Students and course creators: Document coursework and lecture notes with code highlighting, optional math support, and timeline integration.
• Personal wiki enthusiasts: Create a personal wiki with a collapsible file tree and automatic backlinks.

How does Spaceship work?

Start a new project with npm create spaceship@latest, npm create astro@latest -- --template aitorllj93/astro-theme-spaceship, or degit aitorllj93/astro-theme-spaceship. Then drop your Obsidian vault into the content/ folder, customize configuration (navigation, theme colors) in website.config.mjs and styles/global.css, and run npm install && npm run dev to start developing. The theme builds pages from Markdown files with YAML frontmatter, resolving wiki-links and embeds automatically.

Pros and cons

• Pros: Preserves Obsidian syntax without conversion; lightweight and fast static output; MIT licensed and free to modify.
• Cons: Internal links work only for files within the vault structure; search functionality, dark mode toggle, tag pages, and graph view are listed as future improvements, so they are not yet built in.

FAQ

Is Spaceship free?

Yes, Spaceship is licensed under the MIT License, so it is free to use, modify, and share for both personal and commercial projects.

Does Spaceship support wiki-links and embeds?

Yes, the theme natively resolves [[wiki-links]] and embeds like ![[image.png]] from your Obsidian vault, so you do not need to manually convert links or media.

Can I use an existing Obsidian vault with Spaceship?

Yes, you can drop your existing Obsidian vault into the content/ folder. However, note that internal links work only for files within the vault structure.

What customization files are available?

Spaceship offers website.config.mjs for global settings such as site name and default author, styles/global.css for Tailwind CSS styling, and content.config.ts for defining your collections, including the Obsidian vault collection.