Publish Guide

Two paths to get listed. Both produce the same result: a public GitHub repo with one Vault Hub topic and a root hub.md note.

Recommended

Obsidian Plugin

Publish CSS snippets, notes, dashboards, and multi-file vault templates directly from Obsidian.

01Install the Vault Hub plugin from Obsidian Community Plugins

02Add your GitHub token in the plugin settings

03Run "Vault Hub: Publish Resource" from the command palette

04Select CSS Snippet, Note / Template / Dashboard, or Vault / Multi-file Template

05Confirm plugins, write a README, and publish

The plugin creates hub.md, generates a README, and adds the matching GitHub topic.

Manual GitHub Setup

No plugin needed. Create a public GitHub repo yourself and add these two things.

01Create a GitHub repo with your resource files

02Add exactly one discovery topic: obsidian-vault-template, obsidian-css-snippet, obsidian-note-template, or obsidian-dashboard

03Add extra topics that match category slugs (dashboard, student, developer, writer, pkm, publishing, reference, web-clipper, kanban, etc.) to auto-categorize

04Optionally add hub.md in the repo root for richer metadata (name, tagline, screenshots, plugins)

05Use type: vault, type: snippet, or type: note to match the topic

06Wait for the next catalog refresh

Topic-only repos can be discovered, but hub.md is what makes the listing accurate.

hub.md Spec

Put this file at the root of the GitHub repo as hub.md. It opens normally in Obsidian.

Topic and type must match:

obsidian-vault-template uses type: vault
obsidian-css-snippet uses type: snippet
obsidian-note-template uses type: note
obsidian-dashboard uses type: note and auto-adds categories: [dashboard]

Category topics (optional, auto-detected):

Any GitHub topic on your repo that matches one of these slugs will be added as a category, no hub.md required:

starter, student, developer, writer, researcher, ai, pkm, project-management, worldbuilding, journaling, ui-tweak, layout, typography, colors, editor, sidebar, dashboard, daily-note, tracker, query, project-template, kanban, book-notes, habit-tracker, finance, publishing, reference, web-clipper

Example: obsidian-vault-template + student + pkm -> a vault cataloged under Student and PKM.

---
schema: 1
type: snippet  # snippet | note | vault
name: "My Resource Name"
tagline: "One-line description"
author: your-github-username
categories: [ui-tweak]
tags: [custom-tag]
compatible_themes: [minimal]  # snippets only
screenshots:
  - https://raw.githubusercontent.com/user/repo/main/screenshot.png
plugins:
  - id: dataview
    name: "Dataview"
    version: "0.5.67"
environment:
  obsidian_version: "1.8.0"
  theme: default
files:
  - path: snippet.css
    type: css
---

# My Resource Name

Your full README content goes here.
Describe what it does, how to use it, screenshots, etc.