joplin-plugin-heading-navigator 0.9.3 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -18,7 +18,7 @@ A Joplin plugin that provides a simple overlay panel allowing you to navigate an
18
18
 
19
19
  ## How to use
20
20
 
21
- In the markdown editor, click the Heading Navigator toolbar button, or use the assigned keyboard shortcut.
21
+ In the markdown editor, click the Heading Navigator button in the note toolbar (desktop) or the editor toolbar (mobile), or use the assigned keyboard shortcut. On desktop, the button is grayed out when the markdown editor isn't visible (Rich Text editor or viewer-only layout).
22
22
 
23
23
  There isn't a default keyboard shortcut, you can assign one under Tools | Options | Keyboard Shortcuts | "Go to Heading" command.
24
24
 
@@ -50,11 +50,12 @@ The plugin can be customized via Tools | Options | Heading Navigator:
50
50
  - Prevents the panel from obscuring too much content
51
51
  - **Panel top offset**: 0-200px distance from the top of the editor (default: 12px)
52
52
  - Push the panel down to avoid overlapping other top-right editor decorations, such as a backlinks indicator (desktop only)
53
- - **Heading metadata display**: What each heading row shows alongside its text (default: Full)
54
- - **Full**: the `H# - line #` metadata row
55
- - **Compact**: an `H#` level badge instead of the metadata row
53
+ - **Heading metadata display**: What each heading row shows alongside its text (default: Level and line number)
54
+ - **Level and line number**: an `H# - line #` metadata row above the text
55
+ - **Level badge**: an `H#` badge at the right edge of the row
56
+ - **Markdown prefix**: a Markdown heading prefix (`#` through `######`) before the text, including for headings written with Setext underlines
56
57
  - **None**: no level indicator at all
57
- - Compact and None also reduce heading row height on desktop, so more headings fit in the panel. Mobile keeps its larger touch targets.
58
+ - Every option except Level and line number uses shorter, single-line rows on desktop, so more headings fit in the panel. Mobile keeps its larger touch targets.
58
59
  - **Preview headings while navigating**: Scroll the editor to the highlighted heading while filtering or using keyboard navigation (default: on, desktop only)
59
60
  - **Copy internal anchor links**: Copy `[Heading](#heading-anchor)` instead of `[Heading @ Note](:/noteId#heading-anchor)` (default: off)
60
61
 
@@ -69,3 +70,14 @@ Panel appearance settings take effect the next time the panel is opened. The cop
69
70
  - Long-press a heading to copy its link.
70
71
 
71
72
  - Filtering and keyboard navigation highlight headings in the panel without scrolling the note behind the modal. Selecting a heading still navigates to it.
73
+
74
+ ## Building from source
75
+
76
+ Requires Node 22 or later.
77
+
78
+ ```sh
79
+ npm ci
80
+ npm run dist
81
+ ```
82
+
83
+ The build creates the installable plugin at `publish/com.bwat47.heading-navigator.jpl`.
package/package.json CHANGED
@@ -1,19 +1,25 @@
1
1
  {
2
2
  "name": "joplin-plugin-heading-navigator",
3
- "version": "0.9.3",
3
+ "version": "1.0.0",
4
4
  "scripts": {
5
- "dist": "webpack --env joplin-plugin-config=buildMain && webpack --env joplin-plugin-config=buildExtraScripts && webpack --env joplin-plugin-config=createArchive",
5
+ "dist": "npm run typecheck && joplin-plugin-scripts build",
6
6
  "prepare": "npm run dist",
7
- "updateVersion": "webpack --env joplin-plugin-config=updateVersion",
8
- "update": "npm install -g generator-joplin && yo joplin --node-package-manager npm --update --force",
9
- "lint": "eslint --ext .ts src/",
10
- "lint:fix": "eslint --ext .ts src/ --fix",
11
- "format": "prettier --write \"src/**/*.ts\"",
7
+ "updateVersion": "joplin-plugin-scripts update-version",
8
+ "updateApi": "joplin-plugin-scripts update-api",
9
+ "lint": "oxlint src/ && npm run lint:dead-code && npm run lint:complexity",
10
+ "lint:dead-code": "fallow dead-code",
11
+ "lint:complexity": "fallow health --complexity",
12
+ "lint:fix": "oxlint src/ --fix",
13
+ "format": "oxfmt --write",
14
+ "format:check": "oxfmt --check",
12
15
  "test": "vitest run",
13
16
  "test:watch": "vitest",
14
- "knip": "knip"
17
+ "typecheck": "tsc --noEmit"
15
18
  },
16
19
  "license": "MIT",
20
+ "engines": {
21
+ "node": "^22.22.2 || ^24.15.0 || >=26.0.0"
22
+ },
17
23
  "keywords": [
18
24
  "joplin-plugin"
19
25
  ],
@@ -21,41 +27,25 @@
21
27
  "publish"
22
28
  ],
23
29
  "devDependencies": {
24
- "@codemirror/lang-markdown": "6.5.1",
25
- "@codemirror/language": "6.12.4",
26
- "@codemirror/state": "6.5.2",
27
- "@codemirror/view": "6.38.7",
28
- "@eslint/js": "^10.0.1",
29
- "@lezer/common": "^1.5.2",
30
- "@lezer/markdown": "^1.6.0",
31
- "@types/node": "^25.9.4",
32
- "@typescript-eslint/eslint-plugin": "^8.59.2",
33
- "@typescript-eslint/parser": "^8.59.2",
34
- "chalk": "^4.1.0",
35
- "copy-webpack-plugin": "^14.0.0",
36
- "eslint": "^10.3.0",
37
- "eslint-config-prettier": "^10.1.8",
38
- "eslint-plugin-import-x": "^4.16.2",
39
- "eslint-plugin-sonarjs": "^4.2.0",
40
- "fs-extra": "^10.1.0",
41
- "glob": "^8.0.3",
42
- "globals": "^17.7.0",
43
- "jsdom": "^29.1.1",
44
- "knip": "^6.24.0",
45
- "prettier": "^3.8.3",
46
- "tar": "^7.5.16",
47
- "ts-loader": "^9.5.7",
48
- "typescript": "^6.0.3",
49
- "vitest": "^4.1.10",
50
- "webpack": "^5.106.2",
51
- "webpack-cli": "^7.0.2"
30
+ "@bwat47/joplin-plugin-scripts": "^1.6.3",
31
+ "@codemirror/lang-markdown": "6.5.0",
32
+ "@codemirror/language": "6.12.3",
33
+ "@codemirror/state": "6.7.1",
34
+ "@codemirror/view": "6.43.14",
35
+ "@lezer/common": "1.5.0",
36
+ "@lezer/markdown": "1.6.3",
37
+ "@types/node": "^24.19.2",
38
+ "fallow": "^3.43.0",
39
+ "jsdom": "^31.0.1",
40
+ "oxfmt": "^0.78.0",
41
+ "oxlint": "^1.93.0",
42
+ "oxlint-tsgolint": "^7.0.2007",
43
+ "typescript": "^7.0.2",
44
+ "vitest": "^5.1.0"
52
45
  },
53
46
  "dependencies": {
54
- "@joplin/fork-uslug": "^2.0.6",
55
- "entities": "^8.1.0",
56
- "fuzzysort": "^3.1.0"
57
- },
58
- "overrides": {
59
- "js-yaml": "^4.2.0"
47
+ "@joplin/fork-uslug": "^2.0.10",
48
+ "entities": "^9.0.0",
49
+ "fuzzysort": "^4.0.2"
60
50
  }
61
51
  }
@@ -1,62 +1,66 @@
1
1
  {
2
- "manifest_version": 1,
3
- "id": "com.bwat47.heading-navigator",
4
- "app_min_version": "3.3",
5
- "version": "0.9.3",
6
- "platforms": [
7
- "desktop",
8
- "mobile"
9
- ],
10
- "name": "Heading Navigator",
11
- "description": "VS Code/Sublime text style overlay panel to navigate through headings (toc/table of contents) in the markdown editor",
12
- "author": "bwat47",
13
- "homepage_url": "https://github.com/bwat47/joplin-heading-navigator",
14
- "repository_url": "https://github.com/bwat47/joplin-heading-navigator",
15
- "keywords": [
16
- "heading",
17
- "outline",
18
- "keyboard",
19
- "navigation",
20
- "toc"
21
- ],
22
- "categories": [
23
- "productivity",
24
- "editor"
25
- ],
26
- "screenshots": [
27
- {
28
- "src": "images/screenshot1.png",
29
- "label": "Heading Navigator screenshot 1"
30
- },
31
- {
32
- "src": "images/screenshot2.png",
33
- "label": "Heading Navigator screenshot 2"
34
- },
35
- {
36
- "src": "images/screenshot3.png",
37
- "label": "Heading Navigator screenshot 3"
38
- },
39
- {
40
- "src": "images/screenshot_full_mode.png",
41
- "label": "Heading Navigator screenshot full mode"
42
- },
43
- {
44
- "src": "images/screenshot_none_mode.png",
45
- "label": "Heading Navigator screenshot none mode"
46
- }
47
- ],
48
- "icons": {
49
- "16": "images/16.png",
50
- "24": "images/24.png",
51
- "32": "images/32.png",
52
- "48": "images/48.png",
53
- "64": "images/64.png",
54
- "128": "images/128.png"
55
- },
56
- "promo_tile": {
57
- "src": "images/heading-navigator_promo_tile.png",
58
- "label": "heading Navigator Promo Tile"
59
- },
60
- "_publish_hash": "sha256:cf463155a2853d469fd1b332596ef2a5794c46320404e85b0a58f06bd1e33229",
61
- "_publish_commit": "main:47e9010762667bb39c943fa84dae89eab4f6f449"
62
- }
2
+ "manifest_version": 1,
3
+ "id": "com.bwat47.heading-navigator",
4
+ "app_min_version": "3.3",
5
+ "version": "1.0.0",
6
+ "platforms": [
7
+ "desktop",
8
+ "mobile"
9
+ ],
10
+ "name": "Heading Navigator",
11
+ "description": "VS Code/Sublime text style overlay panel to navigate through headings (toc/table of contents) in the markdown editor",
12
+ "author": "bwat47",
13
+ "homepage_url": "https://github.com/bwat47/joplin-heading-navigator",
14
+ "repository_url": "https://github.com/bwat47/joplin-heading-navigator",
15
+ "keywords": [
16
+ "heading",
17
+ "outline",
18
+ "keyboard",
19
+ "navigation",
20
+ "toc"
21
+ ],
22
+ "categories": [
23
+ "productivity",
24
+ "editor"
25
+ ],
26
+ "screenshots": [
27
+ {
28
+ "src": "images/screenshot_theme_light.png",
29
+ "label": "Heading Navigator light theme - heading badge mode"
30
+ },
31
+ {
32
+ "src": "images/screenshot_theme_dark.png",
33
+ "label": "Heading Navigator dark theme - heading badge mode"
34
+ },
35
+ {
36
+ "src": "images/screenshot_mobile.png",
37
+ "label": "Heading Navigator mobile screenshot"
38
+ },
39
+ {
40
+ "src": "images/screenshot_full_mode.png",
41
+ "label": "Heading Navigator screenshot full mode"
42
+ },
43
+ {
44
+ "src": "images/screenshot_atx_mode.png",
45
+ "label": "Heading Navigator screenshot atx mode"
46
+ },
47
+ {
48
+ "src": "images/screenshot_none_mode.png",
49
+ "label": "Heading Navigator screenshot none mode"
50
+ }
51
+ ],
52
+ "icons": {
53
+ "16": "images/16.png",
54
+ "24": "images/24.png",
55
+ "32": "images/32.png",
56
+ "48": "images/48.png",
57
+ "64": "images/64.png",
58
+ "128": "images/128.png"
59
+ },
60
+ "promo_tile": {
61
+ "src": "images/heading_navigator_promo_tile.png",
62
+ "label": "heading Navigator Promo Tile"
63
+ },
64
+ "_publish_hash": "sha256:832e950a341d8ecc3f02b7974b25276ca11af3608d5a43283c7ea48a099b24fd",
65
+ "_publish_commit": "main:665e9e33c68180e7d357975471520466b6842cf4"
66
+ }