joplin-plugin-theme-studio 0.0.0-stage β 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/LICENSE +21 -0
- package/README.md +129 -2
- package/dist/index.js +1 -0
- package/package.json +43 -4
- package/publish/org.joplin.plugin.theme-studio.jpl +0 -0
- package/publish/org.joplin.plugin.theme-studio.json +38 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 xyasharx
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,130 @@
|
|
|
1
|
-
#
|
|
1
|
+
# π¨ Theme Studio for Joplin
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://joplinapp.org/)
|
|
4
|
+
[](#-installation)
|
|
5
|
+
[](https://opensource.org/licenses/MIT)
|
|
6
|
+
|
|
7
|
+
> **Theme Studio** is an all-in-one visual engine for Joplin. Switch instantly between iconic color schemes (Tokyo Night, Everforest, Catppuccin, Nord, Dracula, Gruvbox, Atom One) with full **RTL/LTR typography**, mobile responsiveness, and polished diagram renderingβ**without ever touching `userstyle.css` again.**
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## β¨ Why Theme Studio?
|
|
12
|
+
|
|
13
|
+
Tired of copying CSS snippets, broken bullet points in RTL, unreadable white text in light-mode tables, or clipped Mermaid diagrams?
|
|
14
|
+
|
|
15
|
+
**Theme Studio** moves all custom styling into a single, configurable plugin:
|
|
16
|
+
- π **One-Click Palette Switching:** Change themes dynamically from Joplin's settings.
|
|
17
|
+
- π **Native RTL & Bidirectional Engine:** Flawless right-to-left alignment powered by [Vazirmatn](https://github.com/rastikerdar/vazirmatn), with full bullet marker and border fixes.
|
|
18
|
+
- π **Isolated LTR Blocks:** Mix English and RTL text seamlessly using `<div dir="ltr">...</div>`.
|
|
19
|
+
- π± **Mobile & Desktop Ready:** Works across Joplin Desktop (Windows, macOS, Linux) and Joplin Mobile (Android/iOS).
|
|
20
|
+
- π **Enhanced Mermaid Diagrams:** Centered flowcharts, rounded nodes, transparent label backgrounds, and horizontal scrollbars.
|
|
21
|
+
- π» **ASCII-Preserved Code Blocks:** Horizontal scrolling prevents line wrapping from breaking folder trees or terminal outputs.
|
|
22
|
+
- π **Fixed Table Contrast:** Resolves Joplin's light-mode unreadable table cell bug and adds responsive table scrolling.
|
|
23
|
+
- π¨οΈ **Print & PDF Optimization:** Auto-strips dark backgrounds and formats headings cleanly for clean PDF exports.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## π¨ Built-In Themes
|
|
28
|
+
|
|
29
|
+
| Theme | Mode | Description |
|
|
30
|
+
| :--- | :---: | :--- |
|
|
31
|
+
| **Tokyo Night** | Dark | Deep navy aesthetic with vivid neon accents |
|
|
32
|
+
| **Tokyo Night Storm** | Dark | Softer midnight-slate variation |
|
|
33
|
+
| **Everforest Dark** | Dark | Nature-inspired, warm green environment |
|
|
34
|
+
| **Everforest Light** | Light | Organic, paper-soft tones for comfortable daytime reading |
|
|
35
|
+
| **Catppuccin Mocha** | Dark | Modern, soothing pastel dark theme |
|
|
36
|
+
| **Catppuccin Latte** | Light | Crisp, high-contrast pastel light theme |
|
|
37
|
+
| **Nord** | Dark | Elegant, arctic-blue cold palette |
|
|
38
|
+
| **Dracula** | Dark | Classic vibrant purple and high-contrast accents |
|
|
39
|
+
| **Gruvbox Dark** | Dark | Retro groove warm amber/brown palette |
|
|
40
|
+
| **Gruvbox Light** | Light | Warm retro parchment aesthetic |
|
|
41
|
+
| **Atom One Dark** | Dark | The classic One Dark editor standard |
|
|
42
|
+
| **Atom One Light** | Light | Clean, balanced One Light palette |
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## π Installation
|
|
47
|
+
|
|
48
|
+
### Option 1: In-App Search (Recommended)
|
|
49
|
+
1. Open Joplin Desktop.
|
|
50
|
+
2. Go to **Tools > Options > Plugins** (macOS: **Joplin > Preferences > Plugins**).
|
|
51
|
+
3. Search for **`Theme Studio`**.
|
|
52
|
+
4. Click **Install** and restart Joplin.
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
### Option 2: Manual Installation (`.jpl` file)
|
|
57
|
+
|
|
58
|
+
#### On Desktop:
|
|
59
|
+
1. Download the latest `org.joplin.plugin.theme-studio.jpl` from the [Releases](https://github.com/yourusername/joplin-plugin-theme-studio/releases) page.
|
|
60
|
+
2. Open Joplin > **Tools > Options > Plugins**.
|
|
61
|
+
3. Click the gear icon (**β**) in the top right > **Install from file**.
|
|
62
|
+
4. Select the downloaded `.jpl` file and restart Joplin.
|
|
63
|
+
|
|
64
|
+
#### On Mobile (Android):
|
|
65
|
+
1. Download the `.jpl` file to your mobile device.
|
|
66
|
+
2. Open Joplin Mobile > Tap the **Menu icon (β‘)** > **Configuration** > **Plugins**.
|
|
67
|
+
3. Under **Advanced**, tap **Install from file**.
|
|
68
|
+
4. Choose the `.jpl` file and restart the Joplin app.
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## βοΈ Configuration
|
|
73
|
+
|
|
74
|
+
Once installed, open **Tools > Options > Theme & Typography**:
|
|
75
|
+
|
|
76
|
+
| Setting | Options / Description |
|
|
77
|
+
| :--- | :--- |
|
|
78
|
+
| **Color Theme** | Select any of the 12+ built-in palettes. |
|
|
79
|
+
| **Layout Direction** | Choose **RTL** (Persian/Arabic) or **LTR** (English/Latin). |
|
|
80
|
+
| **Primary Font Stack** | Customize your main reading font (defaults to *Vazirmatn* for RTL). |
|
|
81
|
+
| **Monospace Code Font** | Customize your code font (*Cascadia Code*, *Fira Code*, *JetBrains Mono*). |
|
|
82
|
+
| **Base Font Size** | Adjust font scaling (e.g., `15px`, `16px`, `17px`). |
|
|
83
|
+
| **Line Height** | Adjust line spacing for reading comfort (e.g., `1.7`, `1.8`). |
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## π‘ Mixed-Language (LTR in RTL) Guide
|
|
88
|
+
|
|
89
|
+
When your layout direction is set to **RTL**, you can insert English text, code explanations, or quotes without layout breakage by wrapping them in `<div dir="ltr">`:
|
|
90
|
+
|
|
91
|
+
```html
|
|
92
|
+
<div dir="ltr">
|
|
93
|
+
|
|
94
|
+
### English Subheading
|
|
95
|
+
- List markers automatically sit on the left.
|
|
96
|
+
- Markdown links, bold text, and math render as usual.
|
|
97
|
+
|
|
98
|
+
> Blockquotes automatically flip their accent line to the left border.
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## π οΈ Development & Building
|
|
106
|
+
|
|
107
|
+
To run or modify Theme Studio locally:
|
|
108
|
+
|
|
109
|
+
1. **Clone the repo:**
|
|
110
|
+
```bash
|
|
111
|
+
git clone https://github.com/yourusername/joplin-plugin-theme-studio.git
|
|
112
|
+
cd joplin-plugin-theme-studio
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
2. **Install dependencies:**
|
|
116
|
+
```bash
|
|
117
|
+
npm install
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
3. **Build the plugin package:**
|
|
121
|
+
```bash
|
|
122
|
+
npm run dist
|
|
123
|
+
```
|
|
124
|
+
The compiled `.jpl` bundle will be created inside the `publish/` directory.
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
## π License
|
|
129
|
+
|
|
130
|
+
This project is open-source under the [MIT License](LICENSE).
|
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
(()=>{"use strict";var t={998(t,e){Object.defineProperty(e,"__esModule",{value:!0}),e.default="undefined"!=typeof joplin?joplin:global.joplin},143(t,e){var o,i;e.SettingItemType=e.ContentScriptType=void 0,function(t){t.MarkdownItPlugin="markdownItPlugin",t.CodeMirrorPlugin="codeMirrorPlugin"}(o||(e.ContentScriptType=o={})),function(t){t[t.Int=1]="Int",t[t.String=2]="String",t[t.Bool=3]="Bool",t[t.Array=4]="Array",t[t.Object=5]="Object",t[t.Button=6]="Button"}(i||(e.SettingItemType=i={}))},156(t,e,o){var i=this&&this.__importDefault||function(t){return t&&t.__esModule?t:{default:t}};Object.defineProperty(e,"__esModule",{value:!0});const n=i(o(998)),r=o(143);n.default.plugins.register({onStart:async function(){await n.default.settings.registerSection("themeStudioSection",{label:"Theme Studio",iconName:"fas fa-palette"}),await n.default.settings.registerSettings({theme:{value:"atom-one-dark",type:r.SettingItemType.String,section:"themeStudioSection",isEnum:!0,public:!0,label:"Color Theme",description:"Choose your preferred color scheme.",options:{"atom-one-dark":"Atom One Dark","atom-one-light":"Atom One Light","tokyo-night":"Tokyo Night","tokyo-night-storm":"Tokyo Night Storm","everforest-dark":"Everforest Dark","everforest-light":"Everforest Light","catppuccin-mocha":"Catppuccin Mocha","catppuccin-latte":"Catppuccin Latte",nord:"Nord",dracula:"Dracula","gruvbox-dark":"Gruvbox Dark","gruvbox-light":"Gruvbox Light"}},direction:{value:"rtl",type:r.SettingItemType.String,section:"themeStudioSection",isEnum:!0,public:!0,label:"Layout Direction",description:'Choose primary orientation (RTL includes automatic [dir="ltr"] isolation).',options:{rtl:"Right-to-Left (Persian / Arabic / Hebrew)",ltr:"Left-to-Right (English / Latin)"}},fontFamily:{value:"'Vazirmatn', -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif",type:r.SettingItemType.String,section:"themeStudioSection",public:!0,label:"Primary Font Stack",description:"Main font for reading and note view."},codeFont:{value:"'Cascadia Code', 'Fira Code', 'Consolas', monospace",type:r.SettingItemType.String,section:"themeStudioSection",public:!0,label:"Monospace Code Font",description:"Used for inline code and code blocks."},fontSize:{value:"16px",type:r.SettingItemType.String,section:"themeStudioSection",public:!0,label:"Base Font Size",description:"Standard font size (e.g., 15px, 16px, 17px)."},lineHeight:{value:"1.8",type:r.SettingItemType.String,section:"themeStudioSection",public:!0,label:"Line Height",description:"Reading line height (e.g., 1.7, 1.8)."}}),await n.default.contentScripts.register(r.ContentScriptType.MarkdownItPlugin,"themeStudioMarkdownIt","./markdownTheme.js")}})}};const e={};let o=function o(i){const n=e[i];if(void 0!==n)return n.exports;const r=e[i]={exports:{}};return t[i].call(r.exports,r,r.exports,o),r.exports}(156);const i=exports;for(var n in o)i[n]=o[n];o.__esModule&&Object.defineProperty(i,"__esModule",{value:!0})})();
|
package/package.json
CHANGED
|
@@ -1,6 +1,45 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "joplin-plugin-theme-studio",
|
|
3
|
-
"version": "
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "All-in-one multi-palette engine with native RTL/LTR typography for Joplin",
|
|
5
|
+
"main": "dist/index.js",
|
|
6
|
+
"files": [
|
|
7
|
+
"publish"
|
|
8
|
+
],
|
|
9
|
+
"scripts": {
|
|
10
|
+
"dist": "webpack --env joplin-plugin-config=buildMain && webpack --env joplin-plugin-config=buildExtraScripts && webpack --env joplin-plugin-config=createArchive",
|
|
11
|
+
"build": "webpack --env joplin-plugin-config=buildMain && webpack --env joplin-plugin-config=buildExtraScripts"
|
|
12
|
+
},
|
|
13
|
+
"keywords": [
|
|
14
|
+
"joplin-plugin",
|
|
15
|
+
"theme",
|
|
16
|
+
"dark-theme",
|
|
17
|
+
"light-theme",
|
|
18
|
+
"palette",
|
|
19
|
+
"rtl",
|
|
20
|
+
"ltr",
|
|
21
|
+
"vazirmatn",
|
|
22
|
+
"persian",
|
|
23
|
+
"arabic",
|
|
24
|
+
"tokyo-night",
|
|
25
|
+
"everforest",
|
|
26
|
+
"catppuccin",
|
|
27
|
+
"nord",
|
|
28
|
+
"dracula",
|
|
29
|
+
"gruvbox",
|
|
30
|
+
"atom-one",
|
|
31
|
+
"mermaid"
|
|
32
|
+
],
|
|
33
|
+
"author": "Your Name",
|
|
34
|
+
"license": "MIT",
|
|
35
|
+
"devDependencies": {
|
|
36
|
+
"copy-webpack-plugin": "^14.0.0",
|
|
37
|
+
"fs-extra": "^11.4.1",
|
|
38
|
+
"glob": "^13.0.6",
|
|
39
|
+
"tar": "^7.5.22",
|
|
40
|
+
"ts-loader": "^9.6.2",
|
|
41
|
+
"typescript": "^5.8.3",
|
|
42
|
+
"webpack": "^5.111.1",
|
|
43
|
+
"webpack-cli": "^7.2.3"
|
|
44
|
+
}
|
|
45
|
+
}
|
|
Binary file
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
{
|
|
2
|
+
"manifest_version": 1,
|
|
3
|
+
"id": "org.joplin.plugin.theme-studio",
|
|
4
|
+
"app_min_version": "2.8.0",
|
|
5
|
+
"name": "Theme Studio",
|
|
6
|
+
"version": "1.0.0",
|
|
7
|
+
"description": "All-in-one multi-palette engine (Tokyo Night, Everforest, Catppuccin, Nord, Dracula, Gruvbox, Atom One) with native RTL/LTR typography & mobile support.",
|
|
8
|
+
"author": "Your Name",
|
|
9
|
+
"homepage_url": "https://github.com/yourusername/joplin-plugin-theme-studio",
|
|
10
|
+
"platforms": [
|
|
11
|
+
"desktop",
|
|
12
|
+
"mobile"
|
|
13
|
+
],
|
|
14
|
+
"keywords": [
|
|
15
|
+
"theme",
|
|
16
|
+
"themes",
|
|
17
|
+
"dark-theme",
|
|
18
|
+
"light-theme",
|
|
19
|
+
"palette",
|
|
20
|
+
"rtl",
|
|
21
|
+
"ltr",
|
|
22
|
+
"vazirmatn",
|
|
23
|
+
"persian",
|
|
24
|
+
"arabic",
|
|
25
|
+
"hebrew",
|
|
26
|
+
"tokyo-night",
|
|
27
|
+
"everforest",
|
|
28
|
+
"catppuccin",
|
|
29
|
+
"nord",
|
|
30
|
+
"dracula",
|
|
31
|
+
"gruvbox",
|
|
32
|
+
"atom-one",
|
|
33
|
+
"mobile",
|
|
34
|
+
"mermaid"
|
|
35
|
+
],
|
|
36
|
+
"_publish_hash": "sha256:3416619ffddf0ca9a66673ead6a9e08ce3ceac2c0208bb540b9e7a8fd66429d4",
|
|
37
|
+
"_publish_commit": "1c146728aeb59f0261a284ee55e515ce2e73a826"
|
|
38
|
+
}
|