joplin-plugin-ridgeline 0.2.7 → 0.2.8
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
|
@@ -36,7 +36,7 @@ To install the file by hand instead, download `io.github.pmslava.ridgeline.jpl`
|
|
|
36
36
|
|
|
37
37
|
## Settings
|
|
38
38
|
|
|
39
|
-
All settings live under **Settings → Ridgeline
|
|
39
|
+
All settings live under **Settings → Ridgeline**. Every one applies live, with the single exception of *Show the toolbar toggle button*, which takes effect only after restarting Joplin (see the note in the table).
|
|
40
40
|
|
|
41
41
|
| Setting | Default | What it does |
|
|
42
42
|
| --- | --- | --- |
|
|
@@ -46,6 +46,7 @@ All settings live under **Settings → Ridgeline** and apply live.
|
|
|
46
46
|
| **Maximum heading depth** | H1–H6 | The deepest heading level shown. Headings deeper than this are dropped from the minimap and the outline. |
|
|
47
47
|
| **Show minimap** | On | Master switch for the strip in both panes. Toggle without disabling the plugin (see the command below). |
|
|
48
48
|
| **Hide minimap when the note has no headings** | On | On a heading-less note, hide the strip and drop its reserved margin so the text uses the full width. |
|
|
49
|
+
| **Show the toolbar toggle button** | On | Show the `fa-stream` note-toolbar button that toggles the minimap. **Takes effect only after restarting Joplin** — unlike every other setting here, this one is not live, because the plugin API cannot remove a toolbar button once created. The Tools menu item and `Ctrl+Alt+M` keep working regardless. |
|
|
49
50
|
| **Hover open delay (ms)** | 300 | How long the pointer must rest on the bars before the outline opens (100–1000 ms). Higher = a quick trip across the strip never opens it. |
|
|
50
51
|
|
|
51
52
|
### Commands and shortcuts
|
|
@@ -61,54 +62,15 @@ All three are also in the **Tools** menu, and each flips the matching setting so
|
|
|
61
62
|
## Development
|
|
62
63
|
|
|
63
64
|
```
|
|
65
|
+
git clone https://github.com/pmslava/joplin-plugin-ridgeline
|
|
66
|
+
cd joplin-plugin-ridgeline
|
|
64
67
|
npm install
|
|
65
68
|
npm run dist
|
|
66
69
|
```
|
|
67
70
|
|
|
68
71
|
`npm run dist` builds the publishable plugin to `publish/io.github.pmslava.ridgeline.jpl`.
|
|
69
72
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
The E2E suite drives a real Joplin desktop (Electron) build with the plugin loaded, under a virtual display. It needs Xvfb and the Playwright Chromium host dependencies installed.
|
|
73
|
-
|
|
74
|
-
First fetch the Joplin AppImage the tests run against (downloaded once, then cached under `.e2e-cache/`):
|
|
75
|
-
|
|
76
|
-
```
|
|
77
|
-
npm run setup:e2e
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
The version is pinned in `scripts/setup-e2e.sh` and overridable — it must be at least the manifest's `app_min_version`:
|
|
81
|
-
|
|
82
|
-
```
|
|
83
|
-
JOPLIN_E2E_VERSION=3.7.6 npm run setup:e2e
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
`npm run test:e2e` runs the whole suite in one process (it wraps `playwright test` in `xvfb-run`). The suite launches Joplin many times serially, so on a laptop it is more comfortable to run it in **four shards**, each in the foreground:
|
|
87
|
-
|
|
88
|
-
```
|
|
89
|
-
npm run dist
|
|
90
|
-
npm run setup:e2e
|
|
91
|
-
xvfb-run -a --server-args="-screen 0 1920x1080x24" npx playwright test --shard=1/4
|
|
92
|
-
xvfb-run -a --server-args="-screen 0 1920x1080x24" npx playwright test --shard=2/4
|
|
93
|
-
xvfb-run -a --server-args="-screen 0 1920x1080x24" npx playwright test --shard=3/4
|
|
94
|
-
xvfb-run -a --server-args="-screen 0 1920x1080x24" npx playwright test --shard=4/4
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
The `-screen 0 1920x1080x24` server args give the virtual display enough room for the split-pane layouts the specs assert against.
|
|
98
|
-
|
|
99
|
-
### Regenerating the screenshots
|
|
100
|
-
|
|
101
|
-
The README/manifest screenshots are produced by a separate, opt-in spec that captures (rather than asserts) against a throwaway profile forced to Joplin's dark theme:
|
|
102
|
-
|
|
103
|
-
```
|
|
104
|
-
npm run dist
|
|
105
|
-
npm run setup:e2e
|
|
106
|
-
SHOWCASE=1 xvfb-run -a --server-args="-screen 0 1920x1080x24" npx playwright test e2e/showcase.spec.ts
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
It writes the PNGs into `docs/images/`. Its content is fictional ("Acme Rocket Skates") — it never touches your real Joplin profile.
|
|
110
|
-
|
|
111
|
-
See [PUBLISHING.md](PUBLISHING.md) for the release flow.
|
|
73
|
+
For the end-to-end test suite, regenerating the showcase screenshots, and a tour of the repository layout, see [DEVELOPMENT.md](DEVELOPMENT.md). See [PUBLISHING.md](PUBLISHING.md) for the release flow.
|
|
112
74
|
|
|
113
75
|
## Credits
|
|
114
76
|
|
package/package.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "joplin-plugin-ridgeline",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.8",
|
|
4
4
|
"description": "Ridgeline: a hover-expanding minimap outline for the Joplin editor and viewer.",
|
|
5
5
|
"homepage": "https://github.com/pmslava/joplin-plugin-ridgeline",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
8
|
-
"url": "https://github.com/pmslava/joplin-plugin-ridgeline"
|
|
8
|
+
"url": "git+https://github.com/pmslava/joplin-plugin-ridgeline.git"
|
|
9
9
|
},
|
|
10
10
|
"publishConfig": {
|
|
11
11
|
"access": "public"
|
|
Binary file
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"manifest_version": 1,
|
|
3
3
|
"id": "io.github.pmslava.ridgeline",
|
|
4
4
|
"app_min_version": "3.3",
|
|
5
|
-
"version": "0.2.
|
|
5
|
+
"version": "0.2.8",
|
|
6
6
|
"name": "Ridgeline",
|
|
7
7
|
"description": "A hover-expanding minimap outline for the Markdown editor and viewer: a compact stack of level-encoded bars that tracks the current section and expands into a full clickable table of contents on hover. Theme-aware, live settings, multi-window.",
|
|
8
8
|
"author": "pmslava",
|
|
@@ -35,6 +35,6 @@
|
|
|
35
35
|
"label": "In a split view the strip tracks the current section in both the editor and the rendered viewer at once"
|
|
36
36
|
}
|
|
37
37
|
],
|
|
38
|
-
"_publish_hash": "sha256:
|
|
39
|
-
"_publish_commit": "
|
|
38
|
+
"_publish_hash": "sha256:6fd1ae64453eda732428c9580e37c4b00bf9c86f8f2b225d94400311a48e8e18",
|
|
39
|
+
"_publish_commit": "master:37bc35e35bd47afe242f5105b3f51ae08dfc2daa"
|
|
40
40
|
}
|