Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CIMSTA/obsidiosaurus
Obsidian -> Docusaurus Converter
https://github.com/CIMSTA/obsidiosaurus
converter docusaurus obsidian-md
Last synced: about 2 months ago
JSON representation
Obsidian -> Docusaurus Converter
- Host: GitHub
- URL: https://github.com/CIMSTA/obsidiosaurus
- Owner: CIMSTA
- License: mit
- Created: 2023-01-14T12:32:37.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-21T16:40:31.000Z (about 1 year ago)
- Last Synced: 2024-08-08T00:44:43.509Z (5 months ago)
- Topics: converter, docusaurus, obsidian-md
- Language: TypeScript
- Homepage: https://cimsta.github.io/obsidiosaurus-docs/
- Size: 172 KB
- Stars: 129
- Watchers: 5
- Forks: 10
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - CIMSTA/obsidiosaurus - Obsidian -> Docusaurus Converter (TypeScript)
- jimsghstars - CIMSTA/obsidiosaurus - Obsidian -> Docusaurus Converter (TypeScript)
README
Obisidiosaurus
_
Obsidian + Docusaurus = Where your Obsidian notes meet the web
_
# 👋 Introduction
Obsidiosaurus is a converter for [Obsidian](https://obsidian.md/) markdown notes to the static site builder [Docusaurus](https://docusaurus.io/)
It allows for a better experience writing and maintaining the markdown files, since both share a lot of common features.
🚧 CURRENTLY IN DEVELOPMENT! EXPECT BUGS
# 👀 Documentation
You find detailed instructions on how to use and setup in the [official Documentation](https://cimsta.github.io/obsidiosaurus-docs/docs/main/Introduction)
Website made with Docusaurus and Obsidian using Obsidiosaurus, interested to see the Docs repo? [Check here](https://github.com/CIMSTA/obsidiosaurus-docs)
# 📃 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](https://discord.gg/SSGK5tuqJh).
# ✍ Author
[Mat4m0](https://github.com/Mat4m0) - Matthias