@nimtech/nimpress 2.4.0 → 2.6.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/.claude/skills/nimpress/SKILL.md +20 -3
- package/config.schema.json +70 -0
- package/dist/cli.es.js +810 -609
- package/dist/nimpress.es.js +6977 -6860
- package/dist/{plugin-DOmbMyy0.js → plugin-Bj4U3kPF.js} +1264 -1206
- package/dist/plugin.es.js +1 -1
- package/dist/src/cli/completion.d.ts +12 -0
- package/dist/src/cli/completion.d.ts.map +1 -1
- package/dist/src/cli/mcp.d.ts +2 -0
- package/dist/src/cli/mcp.d.ts.map +1 -0
- package/dist/src/cli/plugin.d.ts +3 -0
- package/dist/src/cli/plugin.d.ts.map +1 -0
- package/dist/src/cli.d.ts.map +1 -1
- package/dist/src/config/defaults.d.ts +3 -0
- package/dist/src/config/defaults.d.ts.map +1 -1
- package/dist/src/config/html.d.ts.map +1 -1
- package/dist/src/config/load.d.ts +3 -0
- package/dist/src/config/load.d.ts.map +1 -1
- package/dist/src/config/schema.d.ts +33 -24
- package/dist/src/config/schema.d.ts.map +1 -1
- package/dist/src/framework/components.d.ts +5 -0
- package/dist/src/framework/components.d.ts.map +1 -0
- package/dist/src/framework/createNimpressApp.d.ts.map +1 -1
- package/dist/src/framework/stores/theme.d.ts +4 -0
- package/dist/src/framework/stores/theme.d.ts.map +1 -1
- package/dist/src/index.d.ts +11 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/layout/ThemeMenu.svelte.d.ts +1 -0
- package/dist/src/types.d.ts +15 -0
- package/dist/src/types.d.ts.map +1 -1
- package/dist/style.css +1 -1
- package/package.json +2 -1
- package/src/styles/themes/glass.css +379 -0
- package/src/styles/tokens.css +37 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: nimpress
|
|
3
|
-
description: Drive the nimpress documentation site cli from the terminal. Use when scaffolding a docs site, running or building it, linting content and frontmatter, managing the component workshop with schemas stories and harnesses, exporting pages for the docs sync pipeline, previewing a repo's export folder inside the central docs site, wiring gated pages to the auth provider, or installing this skill and shell completion.
|
|
3
|
+
description: Drive the nimpress documentation site cli from the terminal. Use when scaffolding a docs site, running or building it, linting content and frontmatter, managing the component workshop with schemas stories and harnesses, exporting pages for the docs sync pipeline, previewing a repo's export folder inside the central docs site, wiring gated pages to the auth provider, or installing this skill, the Claude Code plugin with its mcp server, and shell completion.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# nimpress
|
|
@@ -11,7 +11,7 @@ description: Drive the nimpress documentation site cli from the terminal. Use wh
|
|
|
11
11
|
|
|
12
12
|
1. The cli acts on the current working directory. There is no target flag and no remote mode. Change directory into the site before running anything. `view` is the one command that reaches another repo, the central docs site, and it does so through a cache clone it owns.
|
|
13
13
|
|
|
14
|
-
2. Every command except `init`, `skill`, `completion`, `view`, and `cache clear` loads the site config first. A missing or broken `nimpress.config.ts` or `nimpress.config.json` fails the command before it starts, so `nimpress init` is what a bare folder runs first. `view` and `cache clear` run from any repo the docs sync pipeline publishes, config or not.
|
|
14
|
+
2. Every command except `init`, `skill`, `plugin`, `mcp`, `completion`, `view`, and `cache clear` loads the site config first. A missing or broken `nimpress.config.ts` or `nimpress.config.json` fails the command before it starts, so `nimpress init` is what a bare folder runs first. `view` and `cache clear` run from any repo the docs sync pipeline publishes, config or not.
|
|
15
15
|
|
|
16
16
|
3. `nimpress` writes only into the folders the `paths` config block declares. It never writes into the repo root beyond the config, the content folder, `CLAUDE.md`, `AGENTS.md`, and a temporary `index.html` that the build removes. Outside the repo it writes `~/.nimpress` for the links `view` resolves and `~/.tide/nimpress/sites/` for the docs site clones, and nothing else.
|
|
17
17
|
|
|
@@ -158,6 +158,23 @@ nimpress skill put --project
|
|
|
158
158
|
|
|
159
159
|
`get` prints this document. `put` writes it to `~/.claude/skills/nimpress/SKILL.md`, or to `.claude/skills/nimpress/SKILL.md` under the current directory with `--project`, and prints the path it wrote.
|
|
160
160
|
|
|
161
|
+
### plugin
|
|
162
|
+
|
|
163
|
+
```sh
|
|
164
|
+
nimpress plugin put
|
|
165
|
+
nimpress plugin put --project
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
`put` runs `claude plugin marketplace add nimling/nimpress` and `claude plugin install nimpress@nimpress`, at user scope, or at project scope with `--project`. The plugin carries this skill and the nimpress mcp server. It fails when the `claude` cli is missing or either step exits non zero.
|
|
169
|
+
|
|
170
|
+
### mcp
|
|
171
|
+
|
|
172
|
+
```sh
|
|
173
|
+
nimpress mcp
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
Serves every command as a tool over the model context protocol on stdio. The plugin starts it; nothing else does. Tools are named after the command path with underscores, `lint`, `modules_update`, `guard_map`, and take `args` for positionals, `flags` by flag name without the dashes, and `cwd` relative to the project root. `dev`, `view`, and `modules_dev` keep running and return their pid with the first output; `stop` ends one by pid. `skill`, `plugin`, `mcp`, and `completion` are not tools.
|
|
177
|
+
|
|
161
178
|
### completion
|
|
162
179
|
|
|
163
180
|
```sh
|
|
@@ -248,7 +265,7 @@ nimpress completion --auto --skill
|
|
|
248
265
|
|
|
249
266
|
## Failure reading
|
|
250
267
|
|
|
251
|
-
1. `[nimpress] unknown command: <name>` means the first word is not one of `init`, `lint`, `dev`, `build`, `guard`, `modules`, `export`, `skill`, `completion`, `seo`.
|
|
268
|
+
1. `[nimpress] unknown command: <name>` means the first word is not one of `init`, `lint`, `dev`, `build`, `guard`, `modules`, `export`, `skill`, `plugin`, `mcp`, `completion`, `seo`, `view`, `cache`.
|
|
252
269
|
|
|
253
270
|
2. `[nimpress] modules <sub>: several systems configured` means the config declares more than one system and the command needs `--system=<name>`.
|
|
254
271
|
|
package/config.schema.json
CHANGED
|
@@ -462,6 +462,76 @@
|
|
|
462
462
|
"docs/overrides.css"
|
|
463
463
|
]
|
|
464
464
|
},
|
|
465
|
+
"theme": {
|
|
466
|
+
"description": "Theme the site renders in: stock, glass, or a path to a stylesheet building on stock.",
|
|
467
|
+
"type": "string",
|
|
468
|
+
"default": "stock",
|
|
469
|
+
"examples": [
|
|
470
|
+
"glass",
|
|
471
|
+
"docs/theme.css"
|
|
472
|
+
]
|
|
473
|
+
},
|
|
474
|
+
"themes": {
|
|
475
|
+
"description": "Themes the reader can switch between from the header, stock, glass, or stylesheet paths. The theme field names the default.",
|
|
476
|
+
"type": "array",
|
|
477
|
+
"items": {
|
|
478
|
+
"type": "string"
|
|
479
|
+
},
|
|
480
|
+
"examples": [
|
|
481
|
+
[
|
|
482
|
+
"stock",
|
|
483
|
+
"glass"
|
|
484
|
+
]
|
|
485
|
+
]
|
|
486
|
+
},
|
|
487
|
+
"components": {
|
|
488
|
+
"description": "Components replacing the stock ones: a component name to a Svelte component file.",
|
|
489
|
+
"type": "object",
|
|
490
|
+
"propertyNames": {
|
|
491
|
+
"enum": [
|
|
492
|
+
"Header",
|
|
493
|
+
"Announce",
|
|
494
|
+
"Footer",
|
|
495
|
+
"Sidebar",
|
|
496
|
+
"SidebarNode",
|
|
497
|
+
"Breadcrumbs",
|
|
498
|
+
"RightToc",
|
|
499
|
+
"BackToTop",
|
|
500
|
+
"SearchModal",
|
|
501
|
+
"AccountMenu",
|
|
502
|
+
"ThemeMenu",
|
|
503
|
+
"Feedback",
|
|
504
|
+
"SubscribeDialog",
|
|
505
|
+
"CodeBlock",
|
|
506
|
+
"CodeGroup",
|
|
507
|
+
"Tabs",
|
|
508
|
+
"Actions",
|
|
509
|
+
"Feature",
|
|
510
|
+
"Lightbox",
|
|
511
|
+
"MermaidBlock",
|
|
512
|
+
"MathBlock",
|
|
513
|
+
"DBMLBlock",
|
|
514
|
+
"ComponentEmbed",
|
|
515
|
+
"Card",
|
|
516
|
+
"CardGroup",
|
|
517
|
+
"Operation",
|
|
518
|
+
"Schema",
|
|
519
|
+
"ParamRow",
|
|
520
|
+
"MethodBadge",
|
|
521
|
+
"CodeExamples",
|
|
522
|
+
"TryPanel",
|
|
523
|
+
"TryDialog"
|
|
524
|
+
]
|
|
525
|
+
},
|
|
526
|
+
"additionalProperties": {
|
|
527
|
+
"type": "string"
|
|
528
|
+
},
|
|
529
|
+
"examples": [
|
|
530
|
+
{
|
|
531
|
+
"Header": "./docs/theme/Header.svelte"
|
|
532
|
+
}
|
|
533
|
+
]
|
|
534
|
+
},
|
|
465
535
|
"vite": {
|
|
466
536
|
"type": "object",
|
|
467
537
|
"description": "Vite overrides merged into the site and harness configs.",
|