BBazard / obsidian-orgmode-cm6

Orgmode plugin for Obsidian

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Obsidian Orgmode CM6

Orgmode for Obsidian.

Screenshot

This plugin is using a separate codemirror 6 instance with a custom lezer grammar (not everything is implemented). Inspired by https://github.com/ryanpcmcquen/obsidian-org-mode and https://github.com/nothingislost/obsidian-cm6-attributes.

Features

  • collapsable headings
  • customizable todo keywords in the settings
  • customizable colors via css (use the styles.css as a css snippet and tweak it)
  • text markup (bold, italic, underline, strike-through)
  • links (url, vault file, a link to an image is rendered)
  • show orgmode tasks in markdown files (unstable feature, see the dedicated section)

Usage

By default org files are not shown in the sidebar. To display them you need to go into the obsidian settings, section Files and links and check Detect all file extensions.

detect-all-file-extensions

To create an org file in your vault, you currently have to create outside obsidian as obsidian doesn't allow to create a non-markdown file.

If you don't already have an org file, try to create a file called todo.org with the following content:

* TODO [#A] A task with *high* priority

The description of the task

* A collapsed section

You cannot see the description when collapsed

* DONE something done already :sometag:
SCHEDULED: <2023-12-08 Fri 11:13>
:PROPERTIES:
:CREATED: [2023-12-03 Sun 10:48]
:END:

a [[https://github.com/BBazard/obsidian-orgmode-cm6][link]]

Show orgmode tasks in markdown files

This feature is unstable and will likely change in breaking ways in the future.

Currently only TODO and DONE are handled.

orgmode-tasks.mp4

Development

git clone https://github.com/bbazard/obsidian-orgmode-cm6
cd obsidian-orgmode-cm6
npm install
npm run build
npm test
cp main.js styles.css manifest.json "$OBSIDIAN_VAULT"/.obsidian/plugins/obsidian-orgmode-cm6/

About

Orgmode plugin for Obsidian

License:MIT License


Languages

Language:TypeScript 95.8%Language:CSS 2.7%Language:JavaScript 0.9%Language:Shell 0.7%