joplin-plugin-chordpro 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
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Joplin ChordPro Plugin
|
|
2
|
+
|
|
3
|
+
This plugin for Joplin renders ChordPro files, a popular text format for writing and formatting chord charts and lyrics.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Code Block Rendering**: Use standard Markdown ````chordpro` code blocks to format a chord sheet.
|
|
8
|
+
- **Auto-Detection**: The plugin can automatically detect and render pure ChordPro notes, even without the markdown code block.
|
|
9
|
+
- **Customizable Styling**: Configure colors, fonts, and layout options directly within Joplin settings, which automatically updates the look dynamically.
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
You can create a new note with a ````chordpro` code block:
|
|
14
|
+
|
|
15
|
+
```chordpro
|
|
16
|
+
{title: Amazing Grace}
|
|
17
|
+
{artist: John Newton}
|
|
18
|
+
|
|
19
|
+
[G]Amazing grace! How [C]sweet the [G]sound
|
|
20
|
+
That saved a wretch like [D]me!
|
|
21
|
+
I [G]once was lost, but [C]now am [G]found;
|
|
22
|
+
Was blind, but [D]now I [G]see.
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Or omit the code block entirely if the entire note is written in ChordPro syntax!
|
|
26
|
+
|
|
27
|
+
## Settings
|
|
28
|
+
|
|
29
|
+
Settings can be managed under **Options > ChordPro Renderer** in Joplin:
|
|
30
|
+
|
|
31
|
+
- **Chord Color**: Custom color for all chords (e.g., `#E8612E`, `red`, etc.). Default is `#E8612E`.
|
|
32
|
+
- **Lyrics Color**: Custom color for lyrics. Default is `inherit`.
|
|
33
|
+
- **Font Family**: Customize the font family for rendering. Default is `monospace`.
|
|
34
|
+
- **Font Size (px)**: Base font size. Default is `16`.
|
|
35
|
+
- **Use Inline Chords**: Check this to render chords inline with the lyrics via subscript styling, rather than placing them on the line above the lyrics.
|
|
36
|
+
- **Columns**: Set to a value greater than 1 to use a multi-column grid layout for chord charts.
|
|
37
|
+
- **Section Label Font Weight**: Font weight of section labels (e.g., `normal`, `bold`, `900`). Default is `bold`.
|
|
38
|
+
- **Section Label Color**: Color of the section label text. Default is `inherit`.
|
|
39
|
+
- **Enable Section Border**: Display a border around the entire section with a customizable color and layout (2px left border, 1px all other sides, 6px padding).
|
|
40
|
+
- **Section Border Color**: Color of the section border (if enabled). Default is `currentColor`.
|
|
41
|
+
|
|
42
|
+
## Development
|
|
43
|
+
|
|
44
|
+
For information on how to build or publish the plugin, please see [GENERATOR_DOC.md](./GENERATOR_DOC.md).
|
package/package.json
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "joplin-plugin-chordpro",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"scripts": {
|
|
5
|
+
"dist": "webpack --env joplin-plugin-config=buildMain && webpack --env joplin-plugin-config=buildExtraScripts && webpack --env joplin-plugin-config=createArchive",
|
|
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
|
+
},
|
|
10
|
+
"license": "MIT",
|
|
11
|
+
"keywords": [
|
|
12
|
+
"joplin-plugin"
|
|
13
|
+
],
|
|
14
|
+
"files": [
|
|
15
|
+
"publish"
|
|
16
|
+
],
|
|
17
|
+
"devDependencies": {
|
|
18
|
+
"@codemirror/autocomplete": "^6.20.1",
|
|
19
|
+
"@codemirror/language": "^6.12.2",
|
|
20
|
+
"@codemirror/state": "^6.5.4",
|
|
21
|
+
"@codemirror/view": "^6.39.16",
|
|
22
|
+
"@lezer/common": "^1.5.1",
|
|
23
|
+
"@types/node": "^18.7.13",
|
|
24
|
+
"chalk": "^4.1.0",
|
|
25
|
+
"copy-webpack-plugin": "^11.0.0",
|
|
26
|
+
"fs-extra": "^10.1.0",
|
|
27
|
+
"glob": "^8.0.3",
|
|
28
|
+
"markdown-it": "^14.1.1",
|
|
29
|
+
"tar": "^6.1.11",
|
|
30
|
+
"ts-loader": "^9.3.1",
|
|
31
|
+
"typescript": "^4.8.2",
|
|
32
|
+
"webpack": "^5.74.0",
|
|
33
|
+
"webpack-cli": "^4.10.0"
|
|
34
|
+
}
|
|
35
|
+
}
|
|
Binary file
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
{
|
|
2
|
+
"manifest_version": 1,
|
|
3
|
+
"id": "com.chordpro.ChordproRender",
|
|
4
|
+
"app_min_version": "3.5",
|
|
5
|
+
"version": "1.0.0",
|
|
6
|
+
"name": "Chordpro",
|
|
7
|
+
"description": "Renders chordpro in preview, and provides syntax highlighting for chordpro files in the Joplin markdown editor.",
|
|
8
|
+
"author": "Max Keeble",
|
|
9
|
+
"homepage_url": "",
|
|
10
|
+
"repository_url": "",
|
|
11
|
+
"keywords": [],
|
|
12
|
+
"categories": [],
|
|
13
|
+
"screenshots": [],
|
|
14
|
+
"icons": {},
|
|
15
|
+
"promo_tile": {},
|
|
16
|
+
"_publish_hash": "sha256:aa06b40981ada0ca122edc9206d1a3759b038222fcb5d5775b68308c2bcb0ff7",
|
|
17
|
+
"_publish_commit": "main:7d45c3d091a11ff06c3679c80936fb613c7fe95f"
|
|
18
|
+
}
|