Obisidiosaurus

Obsidian + Docusaurus = Where your Obsidian notes meet the web

[!WARNING]

This project is deprecated

Obsidiosaurus is no longer actively maintained.

I am no longer using this project myself, so I will not be developing it further.

A community-maintained fork is available here: https://github.com/KenBlasse/obsidiosaurus

The fork includes:

• Docusaurus v3 support
• GraphicsMagick replaced with the Canvas API
• no native dependencies
• TypeScript 5.4
• fixes for asset paths, ENOENT issues, and orphaned files on rename

Thanks to KenBlasse for continuing the project.

👋 Introduction

Obsidiosaurus is a converter for Obsidian markdown notes to the static site builder Docusaurus

It allows for a better experience writing and maintaining the markdown files, since both share a lot of common features.

👀 Documentation

You find detailed instructions on how to use and setup in the official Documentation Website made with Docusaurus and Obsidian using Obsidiosaurus, interested to see the Docs repo? Check here

📃 Features:

Overview about what is currently supported:

General

• Documentation: ✅
• Blog: ✅
• Multiple Blogs: ✅
• Localisation i18n: ✅
• Multiple Sidebars: ✅
• Versioning: ⛔ (kinda complex)

Standard Formating

• Links: ✅
• Tables: ✅
• Admoninitions: ✅
• Quotes: ✅
• iFrames: ✅
• Codeblocks: ✅
• Head Metadata: ✅
• Checklists: ✅

Assets

• Images: ✅ (.png & .svg)
• Image resize: ✅
• Image converter: ✅ (.jpg, .png, .webp)
• Themed Images: ✅ (light & dark mode)
• Files: ✅ (.pdf, .docx, ..)

Drawings & Diagrams

• Excalidraw: ✅ (light & dark mode)
• diagrams.net ✅ (light only mode)
• Math Equaitons: ✅
• Mermaid: ✅
• UML Diagrams: ❌ (not supported in Docusaurus)
• D2 Diagrams: ❌ (not supported in Docusaurus)

Advanced

• Docusaurus Tabs: ❌ (not supported in Obsidian)
• MDX Support: ❌ (not supported in Obsidian)

💭 Need help?

If you need more info, help or want to provide general feedback, join our Obsidiosaurus Discord Channel.

✍ Author

Mat4m0 - Matthias