Readability Compass
Will your readers keep up? Pick a readability target (≈ CEFR B1/B2/C1); the status bar shows on or off target while you write. In any language. The panel shows why, per section, click to jump. - This plugin has not been manually reviewed by Obsidian staff.
The above warnings are based on limited information and might not always be accurate.
Data
| ID | readability-compass |
| Author | Max |
| Funding | Support the Author |
| Minimum Obsidian Version | 1.13.0 |
| Official Release Date | 2026-07-14 |
| Last update | 2026-09-07 |
Last Refresh
Obsidian Stats last refreshed the data behind this page on Oct 27, 2026.
| Community plugin snapshot | Oct 26, 2026 |
| Repository clone | last successful checkout Oct 7, 2026 |
| Release acquisition | release metadata checked Oct 7, 2026; latest main.js acquired |
Quick Links
- GitHub Repo
- View in Obsidian
- View on Obsidian Community
- View on the Obsidian Hub
- Author Website
- Support the Author
Changes
| Date | Changed Property | Old Value | New Value |
|---|---|---|---|
| 2026-07-14 | Plugin Added | ||
| 2026-07-14 | author | maxonamission | Max |
| 2026-07-14 | description | Know the reading level of your notes to ensure it fits your readers. See a language-independent score (LIX) and specify your own target. Check scores in the status bar and details in the side panel - This plugin has not been manually reviewed by Obsidian staff. | Know the reading level of your notes to ensure it fits your readers. See a language-independent score (LIX) and specify your own target. Check scores in the status bar and details in the side panel. - This plugin has not been manually reviewed by Obsidian staff. |
| 2026-07-14 | description | Know the reading level of your notes to ensure it fits your readers. See a language-independent score (LIX) and specify your own target. Check scores in the status bar and details in the side panel. - This plugin has not been manually reviewed by Obsidian staff. | Know the readability of your notes to ensure it fits your readers. See a language-independent score (LIX) and specify your own target. Check scores in the status bar and details in the side panel. - This plugin has not been manually reviewed by Obsidian staff. |
| 2026-07-16 | description | Know the readability of your notes to ensure it fits your readers. See a language-independent score (LIX) and specify your own target. Check scores in the status bar and details in the side panel. - This plugin has not been manually reviewed by Obsidian staff. | Check the readability of your writing to ensure it fits your readers. See a language-independent score (LIX) and specify your own target. Check scores in the status bar and details in the side panel. - This plugin has not been manually reviewed by Obsidian staff. |
| 2026-07-17 | Plugin Removed | ||
| 2026-07-17 | Plugin Re-Added | ||
| 2026-08-01 | description | Check the readability of your writing to ensure it fits your readers. See a language-independent score (LIX) and specify your own target. Check scores in the status bar and details in the side panel. - This plugin has not been manually reviewed by Obsidian staff. | Will your readers keep up? Pick a readability target (≈ CEFR B1/B2/C1); the status bar shows on or off target while you write. In any language. The panel shows why, per section, click to jump. - This plugin has not been manually reviewed by Obsidian staff. |
Repository Data
| License | GPL-3.0 in package.json GPL-3.0 in LICENSE file |
| Package Manager | npm |
| Uses Typescript | Yes |
| Installed Bundlers | esbuild |
| Installed Testing Frameworks | Vitest |
| Has Test Files | Yes |
Latest Release main.js Size | 114 KB |
| Detected ES Version | ES2018 |
| Probably Minified | No |
| main.js API Findings | 13 disclosures |
| Uses BRAT beta releases | No |
| Dependencies | None |
| Dev Dependencies | @codemirror/state, @codemirror/view, @types/node, @typescript-eslint/parser, esbuild, eslint, eslint-plugin-obsidianmd, obsidian, tslib, typescript, typescript-eslint, vitest |
main.js API Findings
These findings come directly from Glass Lint's JavaScript and Obsidian rule catalogs applied to the latest release main.js. The confidence column is Glass Lint's definite/possible match certainty.
| Disclosure | Rule Descriptions |
|---|---|
| Codemirror Integration | Uses CodeMirror extension primitives |
| Editor Behavior | Registers editor extensions |
| Full Vault Access | Enumerates vault files |
| Lifecycle Events | Registers Obsidian lifecycle events |
| Metadata Access | Extracts tags, links, embeds, blocks, or headings, Reads Obsidian metadata cache, Reads cached frontmatter, Registers metadata cache events, Updates frontmatter through Obsidian APIs |
| Platform Branching | Checks Obsidian platform flags |
| Plugin Storage Access | Reads plugin data, Writes plugin data |
| User Interface Access | Registers Obsidian views, Registers commands, Registers plugin settings UI, Registers status bar items, Uses Obsidian notices |
| Vault Access | Accesses Obsidian vault APIs |
| Vault Read | Reads vault files |
| Vault Write | Updates frontmatter through Obsidian APIs |
| Workspace Access | Registers Obsidian workspace events |
| Workspace Layout | Manages workspace leaves |
| Finding | Type | Confidence | Evidence |
|---|---|---|---|
| Uses CodeMirror extension primitives | Info | Definite | import of "@codemirror/state", import of "@codemirror/view" |
| Registers editor extensions | Info | Definite | member_call of "obsidian.Plugin" |
| Updates frontmatter through Obsidian APIs | Info | Definite | member_call of "app.fileManager.processFrontMatter" |
| Registers Obsidian lifecycle events | Info | Definite | member_call of "obsidian.Plugin" (10) |
| Reads Obsidian metadata cache | Info | Definite | member_read of "app.metadataCache" (6), member_call of "app.metadataCache.getFileCache" (4) |
| Registers metadata cache events | Info | Definite | member_call of "app.metadataCache.on" (2) |
| Extracts tags, links, embeds, blocks, or headings | Info | Definite | member_read of "app.metadataCache.getFileCache.frontmatter" (2) |
| Reads cached frontmatter | Info | Definite | member_read of "app.metadataCache.getFileCache.frontmatter" (2) |
| Checks Obsidian platform flags | Info | Definite | member_read of "obsidian" |
| Reads plugin data | Info | Definite | member_call of "obsidian.Plugin" |
| Writes plugin data | Info | Definite | member_call of "obsidian.Plugin" |
| Registers commands | Info | Definite | member_call of "obsidian.Plugin" (8) |
| Uses Obsidian notices | Info | Definite | constructor of "obsidian.Notice" (4) |
| Registers plugin settings UI | Info | Definite | class of "obsidian.PluginSettingTab", member_call of "obsidian.Plugin" |
| Registers status bar items | Info | Definite | member_call of "obsidian.Plugin" |
| Accesses Obsidian vault APIs | Info | Definite | member_read of "app.vault" (3) |
| Enumerates vault files | Info | Definite | member_call of "app.vault.getAbstractFileByPath", member_call of "app.vault.getMarkdownFiles" |
| Reads vault files | Info | Definite | member_call of "app.vault.cachedRead" |
| Registers Obsidian views | Info | Definite | member_call of "obsidian.Plugin" |
| Registers Obsidian workspace events | Info | Definite | member_call of "app.workspace.on" (4) |
| Manages workspace leaves | Info | Definite | member_call of "app.workspace.getLeavesOfType" (6), member_call of "app.workspace.revealLeaf" (2), member_call of "app.workspace.getLeaf", member_call of "app.workspace.getRightLeaf" |
The above data may not be accurate and contain errors. For more information refer to the page about data collection.
Lines of Code
The plugin has a total of 4986 lines of code. The following chart shows the lines of code split by programming language.
Downloads
The following chart shows the total number of downloads of the plugin over time. The second chart shows the delta of downloads per week, which is the number of new downloads per week. New version releases are marked with vertical lines.
Version History
| Version | Release Date | Note |
|---|---|---|
| 0.1.0 | 2026-07-15 | None |
| 0.2.0 | 2026-07-15 | None |
| 0.2.1 | 2026-07-15 | None |
| 0.3.0 | 2026-07-16 | None |
| 0.4.0 | 2026-07-16 | None |
| 0.4.1 | 2026-07-16 | None |
| 0.4.2 | 2026-07-16 | None |
| 0.5.0 | 2026-07-16 | None |
| 0.5.1 | 2026-07-18 | None |
| 0.6.0 | 2026-07-18 | None |
| 0.7.0 | 2026-07-18 | None |
| 0.8.0 | 2026-07-19 | None |
| 0.8.1 | 2026-07-19 | None |
| 0.8.2 | 2026-07-19 | None |
| 0.8.3 | 2026-07-19 | None |
| 0.8.4 | 2026-07-20 | None |
| 0.9.0 | 2026-08-02 | None |
| 0.9.1 | 2026-08-04 | None |
| 0.10.0 | 2026-09-09 | None |