https://github.com/songkg7/o2

Converts obsidian markdown syntax to other platforms.
https://github.com/songkg7/o2

chirpy converter docusaurus jekyll obsidian obsidian-plugin syntax-transformation

Last synced: 3 months ago
JSON representation

Converts obsidian markdown syntax to other platforms.

• Host: GitHub
• URL: https://github.com/songkg7/o2
• Owner: songkg7
• License: mit
• Created: 2023-02-13T06:59:16.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-04T12:41:59.000Z (3 months ago)
• Last Synced: 2024-08-04T14:51:59.974Z (3 months ago)
• Topics: chirpy, converter, docusaurus, jekyll, obsidian, obsidian-plugin, syntax-transformation
• Language: TypeScript
• Homepage: https://haril.dev/en/docs/category/o2
• Size: 1.12 MB
• Stars: 23
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• project-awesome - songkg7/o2 - Converts obsidian markdown syntax to other platforms. (TypeScript)
• jimsghstars - songkg7/o2 - Converts obsidian markdown syntax to other platforms. (TypeScript)

README

        
# O2

[![CI](https://github.com/songkg7/o2/actions/workflows/ci.yml/badge.svg)](https://github.com/songkg7/o2/actions/workflows/node.js.yml)

[![CodeFactor](https://www.codefactor.io/repository/github/songkg7/o2/badge)](https://www.codefactor.io/repository/github/songkg7/o2)

[![Super-Linter](https://github.com/songkg7/o2/actions/workflows/linter.yml/badge.svg)](https://github.com/marketplace/actions/super-linter)

[![codecov](https://codecov.io/gh/songkg7/o2/branch/main/graph/badge.svg?token=AYQGNW0SWR)](https://codecov.io/gh/songkg7/o2)

[![Obsidian downloads](https://img.shields.io/badge/dynamic/json?logo=Obsidian&color=%238b6cef&label=downloads&query=o2.downloads&url=https://raw.githubusercontent.com/obsidianmd/obsidian-releases/master/community-plugin-stats.json)][community-plugin]

[community-plugin]: https://obsidian.md/plugins?id=o2

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)

```text

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](https://haril.dev/en/docs/category/o2) for more information.

## Plugins that work well together

- [imgur](https://github.com/gavvvr/obsidian-imgur-plugin): Recommanded

- [Update frontmatter time on edit](https://github.com/beaussan/update-time-on-edit-obsidian)

## 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](https://docs.obsidian.md/Plugins/Getting+started/Build+a+plugin).

## Articles

- [O2 plugin 개발하기](https://haril.dev/blog/2023/02/22/develop-obsidian-plugin)

- [Obsidian 플러그인 오픈소스 기여하기](https://l2hyunn.github.io/posts/Obsidian-%ED%94%8C%EB%9F%AC%EA%B7%B8%EC%9D%B8-%EC%98%A4%ED%94%88%EC%86%8C%EC%8A%A4-%EA%B8%B0%EC%97%AC%ED%95%98%EA%B8%B0/)

Welcome to write articles about O2!

## License

This project is published under [MIT](https://choosealicense.com/licenses/mit/) license.

---

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

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/V7V8KX38Q)