Skip to main content

Quick Start ⏱️

Want to see Obsidiosaurus in action quickly? Follow this guide — you'll use the Obsidiosaurus docs repo itself as a demo.

Step 1: Install Essential Tools 🛠️​

Make sure you have the following installed:

Step 2: Clone the obsidiosaurus-docs Repo 📥​

Clone the demo repository to your local machine:

git clone https://github.com/KenBlasse/obsidiosaurus-docs.git
cd obsidiosaurus-docs

This gives you the following structure:

obsidiosaurus-docs/
├── vault/        ← Obsidian Vault (the source)
└── website/      ← Docusaurus installation (the output)

Step 3: Launch Docusaurus Dev Server 🚀​

cd website
npm install
npm run start

Open your browser at http://localhost:3000/obsidiosaurus-docs/ — you should see this documentation site running locally. Don't close the terminal.

Step 4: Install Obsidiosaurus via BRAT 🔌​

Obsidiosaurus is currently available via BRAT:

  1. Open Obsidian → Settings → Community Plugins → Browse
  2. Search for BRAT and install it
  3. Enable BRAT
  4. Open BRAT settings → "Add Beta plugin"
  5. Enter: KenBlasse/obsidiosaurus
  6. Enable Obsidiosaurus in your plugin list

Step 5: Open the Vault 🔓​

  • In Obsidian click Open folder as vault
  • Select the vault folder from your cloned repo: .../obsidiosaurus-docs/vault

Step 6: Configure the Plugin ⚙️​

Open Obsidian Settings → Obsidiosaurus and set:

  • Docusaurus Website Directory — point to your website folder

Step 7: Run Obsidiosaurus 📝​

Click the page with up arrow icon in the left sidebar:

obsidiosaurus_sidebar_icon

Once complete, you'll see a success notification:

obsidiosaurus_run_sucess_notifaction

Your changes are now converted and visible in the Docusaurus dev server.

note

The obsidiosaurus-docs vault is set up as a working example. Feel free to edit notes and re-run the conversion to see how it works.

If you run into any issues, open an issue on GitHub.

(Step 8: Optional — Leave a ⭐️ on GitHub)​

If you like it, consider leaving a star at GitHub to support development.