Repository navigation
Releases
Org Live 0.2.4
Org Live 0.2.4 — custom TODO keywords + mobile polish
New
- Custom TODO keywords: Settings → Org Live → Custom TODO keywords, in the Org form
active1 active2 | done1 done2. Custom words are additive to the built-in set and work in live preview, reading view and the Outline. - Per-file keywords:
#+TODO:,#+SEQ_TODO:and#+TYP_TODO:are supported, including fast-access forms likeTODO(t),WAIT(w@/!)andDONE(d!). - Mobile TODO polish: larger TODO badges (about 12 px, 20 px high), better line height inside wrapped headlines, and the same styling in both modes.
Fixed
- Fast-access TODO declarations were previously stored as
TODO(t)instead ofTODO, so headings were not recognized. - Changing TODO keywords now invalidates parser caches and refreshes the core Outline immediately.
Notes
- Default TODO/DONE states render on mobile in both live preview and reading view. If a custom state is still plain text, add it to the setting or declare it with
#+TODO:. - Requires Obsidian 1.13.0+.
Install
- Update through Obsidian's Community plugins or BRAT, or reinstall
zzeitt/obsidian-org-live.
Marketplace listing is already live; this release updates it automatically.
Org Live 0.2.3
Org Live 0.2.3 — community scan fixes
This release addresses the second official scan pass.
Errors fixed
minAppVersionis now1.13.0, matching the declarative settings APIs (getSettingDefinitions,getControlValue,setControlValue,update).- Removed the deprecated
display()fallback and the plugin-name settings heading; settings are fully definition-driven and searchable. - Removed the last
document.create*path: detached widgets use a hiddendocument.body.createDiv()Obsidian host.
Warnings fixed
- Removed all CSS
!importantrules; marker lines use higher-specificitycm-lineselectors. - Removed direct
innerHTML,document.createElement, Prismany, outlinethisaliasing, unhandled promises, unnecessary regex escapes and unused imports.
Release assets
- Only
main.js,manifest.json,styles.css(noversions.jsonrelease asset; it stays at the repo root).
Install
- BRAT → Org Live → Check for updates, or reinstall
zzeitt/obsidian-org-live. - Requires Obsidian 1.13.0+.
Remaining recommendation: GitHub artifact attestations for release assets. Marketplace portal submission remains pending the maintainer's account login/review.
Org Live 0.2.2
Org Live 0.2.2 — community scan fixes
This release addresses the official Obsidian community scan findings.
Errors fixed
- Manifest description no longer contains the word “Obsidian”.
- Removed direct
innerHTMLassignments; reading HTML, live table cells and Prism code now usesanitizeHTMLToDomwith DOM append/replace APIs. - Settings heading uses
Setting.setHeading(), and the tab implementsgetSettingDefinitions()for settings search on Obsidian 1.13+.
Warnings cleaned
document.createElementreplaced with an Obsidian-aware detachedDocumentFragment.createElhelper.- Fixed Outline
thisaliasing, unhandledopenLinkTextpromise,requestAnimationFramein popouts, Prismanytyping, unnecessary regex escapes and unused imports. - Release assets now contain only
main.js,manifest.jsonandstyles.css;versions.jsonstays at the repository root.
Install
- BRAT → Org Live → Check for updates, or reinstall
zzeitt/obsidian-org-live. - Requires Obsidian 1.8.7+.
Remaining recommendations: build provenance attestations and a few CSS !important rules used to collapse Org marker lines. The marketplace portal submission remains pending an Obsidian account login/review.
Org Live 0.2.1
Org Live 0.2.1 — folding + core Outline (polish)
New in 0.2.x
- Code block folding: fold
#+BEGIN_SRC/#+END_SRCand quote/example/center/verse/comment/export blocks from an inline chevron.Ctrl/Cmd-Shift-[/]also work. Folding is view-only; edits, undo and saves are unaffected. - Core Outline integration: Org headlines appear in Obsidian's Outline pane with hierarchy, TODO keywords and Chinese titles. Click an item to jump to the headline. Markdown outlines still use Obsidian's native implementation.
- The Outline bridge is guarded and only answers for
.orgfiles; it restores original methods on unload.
0.2.1 fixes
- Source-block fold control is rendered inside the code-block header, so it is not clipped by the full-line replacement.
- Expected MathJax “not loaded yet” warnings no longer appear on first render.
- Org headline levels above 6 are preserved in the Outline bridge.
Install
- BRAT → Org Live → Check for updates, or reinstall
zzeitt/obsidian-org-live. - Requires Obsidian 1.8.7+.
Community marketplace submission uses the new community.obsidian.md portal and is pending the maintainer's account login/review; BRAT remains the immediate install path.
Org Live 0.2.0
Org Live 0.2.0 — code block folding + core Outline / 代码块折叠与 Outline
New
- Code block folding: fold
#+BEGIN_SRC/#+END_SRCand quote/example/center/verse/comment/export blocks from an inline chevron.Ctrl/Cmd-Shift-[/]also work. Folding is view-only; edits, undo and saves are unaffected. - Core Outline integration: Org headlines appear in Obsidian's Outline pane with hierarchy, TODO keywords and Chinese titles. Click an item to jump to the headline. Markdown outlines still use Obsidian's native implementation.
- The Outline bridge is guarded and only answers for
.orgfiles; it restores original methods on unload.
Also included
- LaTeX/Markdown math delimiters (
\(...\),\[...\], multi-line$$, barealign/equationenvironments). - Native Markdown visual parity, bilingual settings, mobile/iOS adaptation, Prism code highlighting and MathJax.
Upgrade with BRAT
- BRAT → Org Live → Check for updates, or reinstall
zzeitt/obsidian-org-live. - Requires Obsidian 1.8.7+.
Community marketplace submission is pending review; BRAT remains the immediate install path.
Org Live 0.1.1
Org Live 0.1.1 — math delimiter fix / 数学语法修复
This release fixes math rendering for LaTeX/Markdown-style formulas.
Fixed
- Inline math with
\(...\) - Display math with
\[...\] - Multi-line
$$ ... $$ - Bare display environments:
\begin{align},align*,equation,equation*,gather,multline,flalign,alignat,eqnarray,displaymath - Multi-line display math renders as one block in live preview and reading view
- Placing the cursor inside a math block reveals the raw lines for editing; moving away re-renders
- Added
test/math-formats.orgregression corpus
Upgrade
- BRAT → Org Live → check for updates, or reinstall
zzeitt/obsidian-org-live - No configuration changes needed.
Thanks for the bug report with the align / \(...\) examples.
Org Live 0.1.0
Org Live 0.1.0 — first public beta / 首个公开测试版
Org-mode live preview and reading view for Obsidian, with native Markdown visual parity.
Highlights
- Native
.orgfiles: live preview + reading view; no UNITADE required - Reuses Obsidian Markdown/CM6 classes (
HyperMD-*,cm-*,cm-hashtag,task-list-item-checkbox,code-block-flair,math) - TODO/custom TODO keywords, priorities, tags, planning, property drawers,
#+KEYWORDmetadata cards - Lists/checkboxes, tables with
<l>/<c>/<r>alignment, Prism-highlighted source blocks, quotes, math - Interactive checkboxes, internal links, tag search, table click-to-edit, TODO cycling
- Bilingual settings: Auto / English / 中文; command and action labels follow
- Mobile/iOS adaptation: native selection, safe areas, touch targets, table scrolling, Markdown-style code wrapping
- BRAT-ready release assets
Install with BRAT
- Install BRAT from the community plugins.
- BRAT → Add Beta Plugin →
zzeitt/obsidian-org-live - Enable Org Live and disable other
.orgplugins (e.g. Orgmode cm6). - Requires Obsidian 1.8.7+.
Known limitations
- Outline/backlinks/graph/tag pane do not index non-Markdown files (Obsidian API limitation); tag clicks use
:tag:text search. - No headline folding indicators yet.
- Tables are read-only in live preview; click a cell to edit raw text.
- iOS device testing is ongoing; viewport/mobile CSS was verified with 390×844 emulation.
See README.md, README.zh-CN.md and CHANGELOG.md for details.