lowkey-doc 0.0.0-stage → 1.0.1

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 ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Lorenzo Balboni
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,53 @@
1
- # Temporary Holding Version
1
+ <h1 align="center">Lowkey Doc</h1>
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ <p align="center">
4
+ lowkey it's just docs<br>
5
+ A folder of Markdown, as <em>one page you can email</em>
6
+ </p>
7
+
8
+ Lowkey Doc turns a folder of Markdown into one self-contained HTML page. No server, no build step, no dependencies: double-click it and read.
9
+
10
+ - **Draws diagrams that stay readable.** Mermaid still parses your flowcharts, ER and sequence diagrams; [ELK](https://eclipse.dev/elk/) lays them out so every label gets its own space and is tied to its own arrow.
11
+ - **Lets you question a diagram.** Hover an arrow or a box and everything else fades. Click to pin it, **Esc** to let go.
12
+ - **Keeps the docs easy to move around.** A sidebar ordered by the number in each filename, foldable sections, search, and links that work both here and on GitHub.
13
+
14
+ | Mermaid's own layout | Lowkey Doc |
15
+ | --- | --- |
16
+ | ![The same flowchart in Mermaid's layout, labels piled on top of each other](assets/layout-mermaid.jpg) | ![The same flowchart in Lowkey Doc, every label beside its own arrow](assets/layout-lowkey-doc.jpg) |
17
+
18
+ > [!NOTE]
19
+ > The first build needs a connection to download Mermaid, ELK and the Inter font. Every build after that works offline.
20
+
21
+ ## Install
22
+
23
+ Requires Node 22+. Run it without installing anything:
24
+
25
+ ```sh
26
+ npx lowkey-doc ./docs
27
+ ```
28
+
29
+ Or install it once, and test with `--help`:
30
+
31
+ ```sh
32
+ npm install -g lowkey-doc
33
+ lowkey-doc --help
34
+ ```
35
+
36
+ ## Use it
37
+
38
+ | Run | To |
39
+ | --- | --- |
40
+ | `lowkey-doc ./docs` | Render a folder, no setup needed |
41
+ | `lowkey-doc init` | Set a project up once, then just run `lowkey-doc` |
42
+ | `lowkey-doc --watch` | Serve the page and update it on every save |
43
+
44
+ The page is written to `.lowkey-doc/index.html`. `init` also adds a `/docs` command and skills for writing and auditing docs to the project's `.claude/` folder.
45
+
46
+ See the [configuration docs](./docs/3.%20CONFIGURATION.md) for every setting and flag, and [docs/](./docs/0.%20ABOUT.md) for everything else.
47
+
48
+ ## Develop
49
+
50
+ ```sh
51
+ node bin/lowkey-doc.mjs # render this repo's own docs
52
+ npm run check # smoke test
53
+ ```
@@ -0,0 +1,171 @@
1
+ #!/usr/bin/env node
2
+ // lowkey-doc
3
+ // ------------------------------------------------------------------
4
+ // Render a folder of Markdown into one static, self-contained
5
+ // documentation dashboard and open it in the browser.
6
+ //
7
+ // lowkey-doc build the folder in docs.config.json, else docs/
8
+ // lowkey-doc ./docs build this folder instead
9
+ // lowkey-doc --no-open build only
10
+ // lowkey-doc --out <dir> write somewhere else
11
+ // lowkey-doc --refresh re-download the vendored assets
12
+ // lowkey-doc --engine mermaid default every diagram to mermaid's layout
13
+ // lowkey-doc --watch serve it on localhost, update on every save
14
+ // lowkey-doc init [dir] wire a project up
15
+ //
16
+ // Output: <out>/index.html plus a vendor/ folder. The page is plain file://
17
+ // HTML - no server, no network, no npm dependencies. --watch serves the same
18
+ // page while you write, and is the only mode that runs a server.
19
+ // ------------------------------------------------------------------
20
+
21
+ import fs from 'node:fs';
22
+ import path from 'node:path';
23
+ import { loadConfig, CLI, VERSION } from '../src/config.mjs';
24
+ import { build } from '../src/build.mjs';
25
+ import { init } from '../src/init.mjs';
26
+ import { watch, DEFAULT_PORT } from '../src/watch.mjs';
27
+
28
+ // Every option each mode accepts, and whether it takes a value. Anything else
29
+ // is an error: a typo that silently does something else is worse than a stop.
30
+ const COMMON = { '--help': false, '-h': false, '--version': false, '-v': false };
31
+ const BUILD = {
32
+ ...COMMON, '--out': true, '--config': true, '--title': true, '--engine': true,
33
+ '--watch': false, '-w': false, '--port': true, '--no-open': false, '--refresh': false,
34
+ };
35
+ const INIT = { ...COMMON, '--docs': true, '--title': true, '--force': false };
36
+ const COMMANDS = ['init'];
37
+
38
+ const HELP = `lowkey-doc ${VERSION} — render a folder of Markdown into one self-contained page
39
+
40
+ ${CLI} [folder] [options]
41
+ ${CLI} init [folder] [--docs <dir>] [--title <name>] [--force]
42
+
43
+ Options
44
+ folder render this folder instead of the configured one
45
+ --out <dir> where to write the page (default .lowkey-doc)
46
+ --config <file> use this config file (default docs.config.json, searched upwards)
47
+ --title <name> override the dashboard title
48
+ --engine <name> default diagram layout: clean | mermaid
49
+ -w, --watch serve on localhost and update the open page on every save
50
+ --port <n> port for --watch (default ${DEFAULT_PORT}, or the next free one)
51
+ --no-open build without launching a browser
52
+ --refresh re-download mermaid, ELK and the font
53
+ -v, --version print the version
54
+ -h, --help this
55
+
56
+ init
57
+ folder the project to set up (default: here; created if missing)
58
+ --docs <dir> the documents folder (default docs)
59
+ --title <name> the dashboard title
60
+ --force replace the Claude command and skills with this version's.
61
+ An existing config is never replaced: --docs and --title edit it.
62
+ `;
63
+
64
+ const usage = (msg) => { throw new Error(msg + '\nSee: ' + CLI + ' --help'); };
65
+
66
+ // edit distance, for "did you mean"
67
+ function distance(a, b) {
68
+ const row = Array.from({ length: b.length + 1 }, (_, j) => j);
69
+ for (let i = 1; i <= a.length; i++) {
70
+ let prev = row[0]++;
71
+ for (let j = 1; j <= b.length; j++) {
72
+ const cur = row[j];
73
+ row[j] = Math.min(row[j] + 1, row[j - 1] + 1, prev + (a[i - 1] === b[j - 1] ? 0 : 1));
74
+ prev = cur;
75
+ }
76
+ }
77
+ return row[b.length];
78
+ }
79
+ const closest = (word, list) => {
80
+ const best = list.map((w) => [w, distance(word, w)]).sort((x, y) => x[1] - y[1])[0];
81
+ return best && best[1] <= Math.max(1, Math.floor(word.length / 3)) ? best[0] : null;
82
+ };
83
+
84
+ function parse(argv) {
85
+ const takesValue = new Set(Object.entries({ ...BUILD, ...INIT }).filter(([, v]) => v).map(([k]) => k));
86
+ const opts = {};
87
+ const args = [];
88
+ for (let i = 0; i < argv.length; i++) {
89
+ let a = argv[i], value;
90
+ if (!a.startsWith('-') || a === '-') { args.push(a); continue; }
91
+ if (a.includes('=')) [a, value] = [a.slice(0, a.indexOf('=')), a.slice(a.indexOf('=') + 1)];
92
+ if (takesValue.has(a)) {
93
+ if (value === undefined) {
94
+ value = argv[i + 1];
95
+ if (value === undefined || value.startsWith('-')) usage(a + ' needs a value.');
96
+ i++;
97
+ }
98
+ opts[a] = value;
99
+ } else {
100
+ opts[a] = true;
101
+ }
102
+ }
103
+
104
+ const mode = args[0] === 'init' ? 'init' : 'build';
105
+ if (mode === 'init') args.shift();
106
+ const known = mode === 'init' ? INIT : BUILD;
107
+ for (const o of Object.keys(opts)) {
108
+ if (o in known) continue;
109
+ if (mode === 'init' && o in BUILD) usage(o + ' does not apply to init.');
110
+ if (mode === 'build' && o in INIT) usage(o + ' only works with init: ' + CLI + ' init ' + o);
111
+ const near = closest(o, Object.keys(known));
112
+ usage('Unknown option ' + o + '.' + (near ? ' Did you mean ' + near + '?' : ''));
113
+ }
114
+ if (args.length > 1) usage('Expected at most one folder, got: ' + args.join(' '));
115
+ return { mode, folder: args[0] || null, opts };
116
+ }
117
+
118
+ async function main() {
119
+ const { mode, folder, opts } = parse(process.argv.slice(2));
120
+ if (opts['-h'] || opts['--help']) { console.log(HELP); return; }
121
+ if (opts['-v'] || opts['--version']) { console.log(VERSION); return; }
122
+
123
+ if (mode === 'init') {
124
+ const r = init(folder, { docs: opts['--docs'], title: opts['--title'], force: !!opts['--force'] });
125
+ console.log('lowkey-doc init ' + r.root);
126
+ r.done.forEach((d) => console.log(' + ' + d));
127
+ r.skipped.forEach((s) => console.log(' · ' + s));
128
+ if (r.kept) console.log('\n To update the Claude command and skills: ' + CLI + ' init --force');
129
+ console.log('\nRender it with: ' + CLI);
130
+ return;
131
+ }
132
+
133
+ // a folder named here is checked here: "No such folder" is the clearest
134
+ // thing to say, and a mistyped command lands here too
135
+ let docsFolder = null;
136
+ if (folder) {
137
+ docsFolder = path.resolve(folder);
138
+ if (!fs.existsSync(docsFolder)) {
139
+ const near = closest(folder, COMMANDS);
140
+ throw new Error('No such folder: ' + folder + (near ? '\nDid you mean: ' + CLI + ' ' + near + '?' : ''));
141
+ }
142
+ if (!fs.statSync(docsFolder).isDirectory()) throw new Error('Not a folder: ' + folder);
143
+ }
144
+
145
+ const cfgArgs = {
146
+ folder: docsFolder,
147
+ out: opts['--out'] || null,
148
+ title: opts['--title'] || null,
149
+ configPath: opts['--config'] || null,
150
+ engine: opts['--engine'] || null,
151
+ };
152
+
153
+ if (opts['--watch'] || opts['-w']) {
154
+ const port = Number(opts['--port'] ?? DEFAULT_PORT);
155
+ if (!Number.isInteger(port) || port < 0 || port > 65535) {
156
+ usage('--port must be a port number, got: ' + opts['--port']);
157
+ }
158
+ await watch(cfgArgs, { port, open: !opts['--no-open'], refresh: !!opts['--refresh'] });
159
+ return;
160
+ }
161
+ if (opts['--port']) usage('--port only works with --watch.');
162
+
163
+ const cfg = loadConfig(cfgArgs);
164
+
165
+ await build(cfg, { open: !opts['--no-open'], refresh: !!opts['--refresh'] });
166
+ }
167
+
168
+ main().catch((err) => {
169
+ console.error(String(err && err.message || err));
170
+ process.exit(1);
171
+ });
@@ -0,0 +1,38 @@
1
+ ---
2
+ description: Render this project's documents into a dashboard and open it in the browser
3
+ argument-hint: "[--watch] [--no-open] [--refresh] [--out <dir>] [--engine clean|mermaid]"
4
+ allowed-tools: Bash(npx lowkey-doc:*)
5
+ ---
6
+
7
+ Run the documentation dashboard builder:
8
+
9
+ ```bash
10
+ npx lowkey-doc $ARGUMENTS
11
+ ```
12
+
13
+ It reads the documents folder named in `docs.config.json` (or `docs/`) and writes a single
14
+ self-contained page to `.lowkey-doc/index.html`, then opens it in the default browser.
15
+
16
+ Report back briefly:
17
+
18
+ - how many documents were rendered, and how many carry diagrams
19
+ - the output path
20
+ - anything the script printed that looks wrong: a document that failed to parse,
21
+ `mermaid: CDN fallback` (the diagram engine could not be cached locally, so the page will need a
22
+ network connection), `elk: unavailable` (flowcharts and ER diagrams will fall back to mermaid's
23
+ layout), or
24
+ `font: system fallback` (Inter could not be fetched, so the page falls back to a system typeface)
25
+ - `checksum mismatch` anywhere: a download was not the exact file this version pins, so it was
26
+ refused. Say so plainly, and do not try to work around it by fetching the file another way
27
+
28
+ Do not edit any document as part of this command — it only renders.
29
+
30
+ Flags, if asked for:
31
+
32
+ - `--no-open` build without launching the browser
33
+ - `--refresh` re-download the pinned mermaid bundle, the ELK bundle and the Inter woff2
34
+ - `--out <dir>` write the dashboard somewhere else
35
+ - `--engine mermaid` fall back to mermaid's own layout everywhere
36
+ - `--watch` serve the dashboard on localhost and update the open page on every save. It keeps
37
+ running until stopped, so start it in the background and report the address it prints
38
+ - `--port <n>` the port for `--watch` (default 4747)
@@ -0,0 +1,263 @@
1
+ # Eclipse Public License - v 2.0
2
+
3
+ THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
4
+ PUBLIC LICENSE (“AGREEMENT”). ANY USE, REPRODUCTION OR DISTRIBUTION OF
5
+ THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
6
+
7
+ ## 1. DEFINITIONS
8
+
9
+ “Contribution” means:
10
+
11
+ - a\) in the case of the initial Contributor, the initial content
12
+ Distributed under this Agreement, and
13
+ - b\) in the case of each subsequent Contributor:
14
+ - i\) changes to the Program, and
15
+ - ii\) additions to the Program;
16
+
17
+ where such changes and/or additions to the Program originate from
18
+ and are Distributed by that particular Contributor. A Contribution
19
+ “originates” from a Contributor if it was added to the Program by
20
+ such Contributor itself or anyone acting on such Contributor's
21
+ behalf. Contributions do not include changes or additions to the
22
+ Program that are not Modified Works.
23
+
24
+ “Contributor” means any person or entity that Distributes the Program.
25
+
26
+ “Licensed Patents” mean patent claims licensable by a Contributor which
27
+ are necessarily infringed by the use or sale of its Contribution alone
28
+ or when combined with the Program.
29
+
30
+ “Program” means the Contributions Distributed in accordance with this
31
+ Agreement.
32
+
33
+ “Recipient” means anyone who receives the Program under this Agreement
34
+ or any Secondary License (as applicable), including Contributors.
35
+
36
+ “Derivative Works” shall mean any work, whether in Source Code or other
37
+ form, that is based on (or derived from) the Program and for which the
38
+ editorial revisions, annotations, elaborations, or other modifications
39
+ represent, as a whole, an original work of authorship.
40
+
41
+ “Modified Works” shall mean any work in Source Code or other form that
42
+ results from an addition to, deletion from, or modification of the
43
+ contents of the Program, including, for purposes of clarity any new file
44
+ in Source Code form that contains any contents of the Program. Modified
45
+ Works shall not include works that contain only declarations,
46
+ interfaces, types, classes, structures, or files of the Program solely
47
+ in each case in order to link to, bind by name, or subclass the Program
48
+ or Modified Works thereof.
49
+
50
+ “Distribute” means the acts of a) distributing or b) making available in
51
+ any manner that enables the transfer of a copy.
52
+
53
+ “Source Code” means the form of a Program preferred for making
54
+ modifications, including but not limited to software source code,
55
+ documentation source, and configuration files.
56
+
57
+ “Secondary License” means either the GNU General Public License, Version
58
+ 2.0, or any later versions of that license, including any exceptions or
59
+ additional permissions as identified by the initial Contributor.
60
+
61
+ ## 2. GRANT OF RIGHTS
62
+
63
+ - a\) Subject to the terms of this Agreement, each Contributor hereby
64
+ grants Recipient a non-exclusive, worldwide, royalty-free copyright
65
+ license to reproduce, prepare Derivative Works of, publicly display,
66
+ publicly perform, Distribute and sublicense the Contribution of such
67
+ Contributor, if any, and such Derivative Works.
68
+ - b\) Subject to the terms of this Agreement, each Contributor hereby
69
+ grants Recipient a non-exclusive, worldwide, royalty-free patent license
70
+ under Licensed Patents to make, use, sell, offer to sell, import and
71
+ otherwise transfer the Contribution of such Contributor, if any, in
72
+ Source Code or other form. This patent license shall apply to the
73
+ combination of the Contribution and the Program if, at the time the
74
+ Contribution is added by the Contributor, such addition of the
75
+ Contribution causes such combination to be covered by the
76
+ Licensed Patents. The patent license shall not apply to any other
77
+ combinations which include the Contribution. No hardware per se is
78
+ licensed hereunder.
79
+ - c\) Recipient understands that although each Contributor grants the
80
+ licenses to its Contributions set forth herein, no assurances are
81
+ provided by any Contributor that the Program does not infringe the
82
+ patent or other intellectual property rights of any other entity. Each
83
+ Contributor disclaims any liability to Recipient for claims brought by
84
+ any other entity based on infringement of intellectual property rights
85
+ or otherwise. As a condition to exercising the rights and licenses
86
+ granted hereunder, each Recipient hereby assumes sole responsibility to
87
+ secure any other intellectual property rights needed, if any. For
88
+ example, if a third party patent license is required to allow Recipient
89
+ to Distribute the Program, it is Recipient's responsibility to acquire
90
+ that license before distributing the Program.
91
+ - d\) Each Contributor represents that to its knowledge it has sufficient
92
+ copyright rights in its Contribution, if any, to grant the copyright
93
+ license set forth in this Agreement.
94
+ - e\) Notwithstanding the terms of any Secondary License, no Contributor
95
+ makes additional grants to any Recipient (other than those set forth in
96
+ this Agreement) as a result of such Recipient's receipt of the Program
97
+ under the terms of a Secondary License (if permitted under the terms of
98
+ Section 3).
99
+
100
+ ## 3. REQUIREMENTS
101
+
102
+ 3.1 If a Contributor Distributes the Program in any form, then:
103
+
104
+ - a\) the Program must also be made available as Source Code, in accordance
105
+ with section 3.2, and the Contributor must accompany the Program with a
106
+ statement that the Source Code for the Program is available under this
107
+ Agreement, and informs Recipients how to obtain it in a reasonable
108
+ manner on or through a medium customarily used for software exchange;
109
+ and
110
+ - b\) the Contributor may Distribute the Program under a license different
111
+ than this Agreement, provided that such license:
112
+ - i\) effectively disclaims on behalf of all other Contributors all
113
+ warranties and conditions, express and implied, including warranties or
114
+ conditions of title and non-infringement, and implied warranties or
115
+ conditions of merchantability and fitness for a particular purpose;
116
+ - ii\) effectively excludes on behalf of all other Contributors all
117
+ liability for damages, including direct, indirect, special, incidental
118
+ and consequential damages, such as lost profits;
119
+ - iii\) does not attempt to limit or alter the recipients' rights in the
120
+ Source Code under section 3.2; and
121
+ - iv\) requires any subsequent distribution of the Program by any party to
122
+ be under a license that satisfies the requirements of this section 3.
123
+
124
+ 3.2 When the Program is Distributed as Source Code:
125
+
126
+ - a\) it must be made available under this Agreement, or if the Program (i)
127
+ is combined with other material in a separate file or files made
128
+ available under a Secondary License, and (ii) the initial Contributor
129
+ attached to the Source Code the notice described in Exhibit A of this
130
+ Agreement, then the Program may be made available under the terms of
131
+ such Secondary Licenses, and
132
+ - b\) a copy of this Agreement must be included with each copy of
133
+ the Program.
134
+
135
+ 3.3 Contributors may not remove or alter any copyright, patent,
136
+ trademark, attribution notices, disclaimers of warranty, or limitations
137
+ of liability (‘notices’) contained within the Program from any copy of
138
+ the Program which they Distribute, provided that Contributors may add
139
+ their own appropriate notices.
140
+
141
+ ## 4. COMMERCIAL DISTRIBUTION
142
+
143
+ Commercial distributors of software may accept certain responsibilities
144
+ with respect to end users, business partners and the like. While this
145
+ license is intended to facilitate the commercial use of the Program, the
146
+ Contributor who includes the Program in a commercial product offering
147
+ should do so in a manner which does not create potential liability for
148
+ other Contributors. Therefore, if a Contributor includes the Program in
149
+ a commercial product offering, such Contributor (“Commercial
150
+ Contributor”) hereby agrees to defend and indemnify every other
151
+ Contributor (“Indemnified Contributor”) against any losses, damages and
152
+ costs (collectively “Losses”) arising from claims, lawsuits and other
153
+ legal actions brought by a third party against the Indemnified
154
+ Contributor to the extent caused by the acts or omissions of such
155
+ Commercial Contributor in connection with its distribution of the
156
+ Program in a commercial product offering. The obligations in this
157
+ section do not apply to any claims or Losses relating to any actual or
158
+ alleged intellectual property infringement. In order to qualify, an
159
+ Indemnified Contributor must: a) promptly notify the Commercial
160
+ Contributor in writing of such claim, and b) allow the Commercial
161
+ Contributor to control, and cooperate with the Commercial Contributor
162
+ in, the defense and any related settlement negotiations. The Indemnified
163
+ Contributor may participate in any such claim at its own expense.
164
+
165
+ For example, a Contributor might include the Program in a commercial
166
+ product offering, Product X. That Contributor is then a Commercial
167
+ Contributor. If that Commercial Contributor then makes performance
168
+ claims, or offers warranties related to Product X, those performance
169
+ claims and warranties are such Commercial Contributor's responsibility
170
+ alone. Under this section, the Commercial Contributor would have to
171
+ defend claims against the other Contributors related to those
172
+ performance claims and warranties, and if a court requires any other
173
+ Contributor to pay any damages as a result, the Commercial Contributor
174
+ must pay those damages.
175
+
176
+ ## 5. NO WARRANTY {#warranty}
177
+
178
+ EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
179
+ PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN “AS IS”
180
+ BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
181
+ IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
182
+ TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
183
+ PURPOSE. Each Recipient is solely responsible for determining the
184
+ appropriateness of using and distributing the Program and assumes all
185
+ risks associated with its exercise of rights under this Agreement,
186
+ including but not limited to the risks and costs of program errors,
187
+ compliance with applicable laws, damage to or loss of data, programs or
188
+ equipment, and unavailability or interruption of operations.
189
+
190
+ ## 6. DISCLAIMER OF LIABILITY {#disclaimer}
191
+
192
+ EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
193
+ PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
194
+ SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
195
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
196
+ PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
197
+ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
198
+ ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
199
+ EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
200
+ POSSIBILITY OF SUCH DAMAGES.
201
+
202
+ ## 7. GENERAL
203
+
204
+ If any provision of this Agreement is invalid or unenforceable under
205
+ applicable law, it shall not affect the validity or enforceability of
206
+ the remainder of the terms of this Agreement, and without further action
207
+ by the parties hereto, such provision shall be reformed to the minimum
208
+ extent necessary to make such provision valid and enforceable.
209
+
210
+ If Recipient institutes patent litigation against any entity (including
211
+ a cross-claim or counterclaim in a lawsuit) alleging that the Program
212
+ itself (excluding combinations of the Program with other software or
213
+ hardware) infringes such Recipient's patent(s), then such Recipient's
214
+ rights granted under Section 2(b) shall terminate as of the date such
215
+ litigation is filed.
216
+
217
+ All Recipient's rights under this Agreement shall terminate if it fails
218
+ to comply with any of the material terms or conditions of this Agreement
219
+ and does not cure such failure in a reasonable period of time after
220
+ becoming aware of such noncompliance. If all Recipient's rights under
221
+ this Agreement terminate, Recipient agrees to cease use and distribution
222
+ of the Program as soon as reasonably practicable. However, Recipient's
223
+ obligations under this Agreement and any licenses granted by Recipient
224
+ relating to the Program shall continue and survive.
225
+
226
+ Everyone is permitted to copy and distribute copies of this Agreement,
227
+ but in order to avoid inconsistency the Agreement is copyrighted and may
228
+ only be modified in the following manner. The Agreement Steward reserves
229
+ the right to publish new versions (including revisions) of this
230
+ Agreement from time to time. No one other than the Agreement Steward has
231
+ the right to modify this Agreement. The Eclipse Foundation is the
232
+ initial Agreement Steward. The Eclipse Foundation may assign the
233
+ responsibility to serve as the Agreement Steward to a suitable separate
234
+ entity. Each new version of the Agreement will be given a distinguishing
235
+ version number. The Program (including Contributions) may always be
236
+ Distributed subject to the version of the Agreement under which it was
237
+ received. In addition, after a new version of the Agreement is
238
+ published, Contributor may elect to Distribute the Program (including
239
+ its Contributions) under the new version.
240
+
241
+ Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
242
+ receives no rights or licenses to the intellectual property of any
243
+ Contributor under this Agreement, whether expressly, by implication,
244
+ estoppel or otherwise. All rights in the Program not expressly granted
245
+ under this Agreement are reserved. Nothing in this Agreement is intended
246
+ to be enforceable by any entity that is not a Contributor or Recipient.
247
+ No third-party beneficiary rights are created under this Agreement.
248
+
249
+ ## Exhibit A – Form of Secondary Licenses Notice {#exhibit-a}
250
+
251
+ “This Source Code may also be made available under the following
252
+ Secondary Licenses when the conditions for such availability set forth
253
+ in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License v3.0 or later”
254
+
255
+ > Simply including a copy of this Agreement, including this Exhibit A is
256
+ > not sufficient to license the Source Code under Secondary Licenses.
257
+ >
258
+ > If it is not possible or desirable to put the notice in a particular
259
+ > file, then You may include the notice in a location (such as a LICENSE
260
+ > file in a relevant directory) where a recipient would be likely to
261
+ > look for such a notice.
262
+ >
263
+ > You may add additional accurate notices of copyright ownership.
@@ -0,0 +1,93 @@
1
+ Copyright 2016 The Inter Project Authors (https://github.com/rsms/inter) Inter-Italic[opsz,wght].ttf: Copyright 2016 The Inter Project Authors (https://github.com/rsms/inter)
2
+
3
+ This Font Software is licensed under the SIL Open Font License, Version 1.1.
4
+ This license is copied below, and is also available with a FAQ at:
5
+ http://scripts.sil.org/OFL
6
+
7
+
8
+ -----------------------------------------------------------
9
+ SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
10
+ -----------------------------------------------------------
11
+
12
+ PREAMBLE
13
+ The goals of the Open Font License (OFL) are to stimulate worldwide
14
+ development of collaborative font projects, to support the font creation
15
+ efforts of academic and linguistic communities, and to provide a free and
16
+ open framework in which fonts may be shared and improved in partnership
17
+ with others.
18
+
19
+ The OFL allows the licensed fonts to be used, studied, modified and
20
+ redistributed freely as long as they are not sold by themselves. The
21
+ fonts, including any derivative works, can be bundled, embedded,
22
+ redistributed and/or sold with any software provided that any reserved
23
+ names are not used by derivative works. The fonts and derivatives,
24
+ however, cannot be released under any other type of license. The
25
+ requirement for fonts to remain under this license does not apply
26
+ to any document created using the fonts or their derivatives.
27
+
28
+ DEFINITIONS
29
+ "Font Software" refers to the set of files released by the Copyright
30
+ Holder(s) under this license and clearly marked as such. This may
31
+ include source files, build scripts and documentation.
32
+
33
+ "Reserved Font Name" refers to any names specified as such after the
34
+ copyright statement(s).
35
+
36
+ "Original Version" refers to the collection of Font Software components as
37
+ distributed by the Copyright Holder(s).
38
+
39
+ "Modified Version" refers to any derivative made by adding to, deleting,
40
+ or substituting -- in part or in whole -- any of the components of the
41
+ Original Version, by changing formats or by porting the Font Software to a
42
+ new environment.
43
+
44
+ "Author" refers to any designer, engineer, programmer, technical
45
+ writer or other person who contributed to the Font Software.
46
+
47
+ PERMISSION & CONDITIONS
48
+ Permission is hereby granted, free of charge, to any person obtaining
49
+ a copy of the Font Software, to use, study, copy, merge, embed, modify,
50
+ redistribute, and sell modified and unmodified copies of the Font
51
+ Software, subject to the following conditions:
52
+
53
+ 1) Neither the Font Software nor any of its individual components,
54
+ in Original or Modified Versions, may be sold by itself.
55
+
56
+ 2) Original or Modified Versions of the Font Software may be bundled,
57
+ redistributed and/or sold with any software, provided that each copy
58
+ contains the above copyright notice and this license. These can be
59
+ included either as stand-alone text files, human-readable headers or
60
+ in the appropriate machine-readable metadata fields within text or
61
+ binary files as long as those fields can be easily viewed by the user.
62
+
63
+ 3) No Modified Version of the Font Software may use the Reserved Font
64
+ Name(s) unless explicit written permission is granted by the corresponding
65
+ Copyright Holder. This restriction only applies to the primary font name as
66
+ presented to the users.
67
+
68
+ 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
69
+ Software shall not be used to promote, endorse or advertise any
70
+ Modified Version, except to acknowledge the contribution(s) of the
71
+ Copyright Holder(s) and the Author(s) or with their explicit written
72
+ permission.
73
+
74
+ 5) The Font Software, modified or unmodified, in part or in whole,
75
+ must be distributed entirely under this license, and must not be
76
+ distributed under any other license. The requirement for fonts to
77
+ remain under this license does not apply to any document created
78
+ using the Font Software.
79
+
80
+ TERMINATION
81
+ This license becomes null and void if any of the above conditions are
82
+ not met.
83
+
84
+ DISCLAIMER
85
+ THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
86
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
87
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
88
+ OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
89
+ COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
90
+ INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
91
+ DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
92
+ FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
93
+ OTHER DEALINGS IN THE FONT SOFTWARE.
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2014 - 2022 Knut Sveidqvist
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.