Skip to content

Latest commit

 

History

History
72 lines (44 loc) · 2.8 KB

README.md

File metadata and controls

72 lines (44 loc) · 2.8 KB

O2

CI CodeFactor Super-Linter codecov Obsidian downloads

Write once, convert to multiple platforms.

O2 is a tool that converts your Obsidian Markdown files to other Markdown platforms such as Jekyll or Docusaurus.

Prerequisites

Structure of your vault

You should have a folder structure like this. (of course, you can change the folder names in settings)

Your vault
├── ready (where the notes you want to convert are placed)
├── archive (where the original notes before converting are placed)
└── attachments (where the attachments are placed)

Other Folders will be ignored.

How to use

If you want to convert your notes, you should move them to the ready Folder.

then, Execute the command O2: Grammar Transformation via obsidian's cmd + p shortcut.

Supported platforms

  • Jekyll Chirpy
  • Docusaurus

Please visit the documentation for more information.

Plugins that work well together

Contributing

Pull requests are always welcome! For major changes, please open an issue (or discussion) first to discuss what you would like to change. like to change.

For the detailed information about building and developing O2, please visit Obsidian Docs.

Articles

Welcome to write articles about O2!

License

This project is published under MIT license.


If you ever want to buy me a coffee, don't hesitate.

ko-fi