@nimtech/nimpress 2.3.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.
Files changed (223) hide show
  1. package/.claude/rules/changelog-entries.md +229 -0
  2. package/.claude/rules/chunk-cycles.md +23 -0
  3. package/.claude/rules/component-modules.md +152 -0
  4. package/.claude/rules/dbml-pages.md +118 -0
  5. package/.claude/rules/deploy.md +47 -0
  6. package/.claude/rules/doc-pages.md +93 -0
  7. package/.claude/rules/docs-authoring.md +90 -0
  8. package/.claude/rules/docs-sync.md +59 -0
  9. package/.claude/rules/file-layout.md +49 -0
  10. package/.claude/rules/frontmatter.md +91 -0
  11. package/.claude/rules/page-types.md +108 -0
  12. package/.claude/rules/paths.md +27 -0
  13. package/.claude/rules/roadmap-entries.md +154 -0
  14. package/.claude/rules/style.md +61 -0
  15. package/LICENSE +201 -0
  16. package/README.md +137 -0
  17. package/bin/nimpress.mjs +7 -0
  18. package/config.schema.json +555 -0
  19. package/dist/DbmlNote-CTwTd5vM.js +21 -0
  20. package/dist/DbmlTable-BXIyJnLV.js +209 -0
  21. package/dist/cli.es.js +1265 -0
  22. package/dist/nimpress.es.js +8896 -0
  23. package/dist/plugin-DQtunTIv.js +8268 -0
  24. package/dist/plugin.es.js +23 -0
  25. package/dist/src/api/CodeExamples.svelte.d.ts +1 -0
  26. package/dist/src/api/MethodBadge.svelte.d.ts +1 -0
  27. package/dist/src/api/OpenApiRoot.svelte.d.ts +1 -0
  28. package/dist/src/api/Operation.svelte.d.ts +1 -0
  29. package/dist/src/api/ParamRow.svelte.d.ts +1 -0
  30. package/dist/src/api/Schema.svelte.d.ts +1 -0
  31. package/dist/src/api/TryDialog.svelte.d.ts +1 -0
  32. package/dist/src/api/TryPanel.svelte.d.ts +1 -0
  33. package/dist/src/api/refs.d.ts +12 -0
  34. package/dist/src/api/refs.d.ts.map +1 -0
  35. package/dist/src/api/tryState.d.ts +21 -0
  36. package/dist/src/api/tryState.d.ts.map +1 -0
  37. package/dist/src/api/types.d.ts +63 -0
  38. package/dist/src/api/types.d.ts.map +1 -0
  39. package/dist/src/auth/AccountMenu.svelte.d.ts +1 -0
  40. package/dist/src/auth/guard.d.ts +5 -0
  41. package/dist/src/auth/guard.d.ts.map +1 -0
  42. package/dist/src/auth/session.d.ts +8 -0
  43. package/dist/src/auth/session.d.ts.map +1 -0
  44. package/dist/src/banner.d.ts +23 -0
  45. package/dist/src/banner.d.ts.map +1 -0
  46. package/dist/src/cli/export.d.ts +4 -0
  47. package/dist/src/cli/export.d.ts.map +1 -0
  48. package/dist/src/cli/guard.d.ts +3 -0
  49. package/dist/src/cli/guard.d.ts.map +1 -0
  50. package/dist/src/cli/init.d.ts +2 -0
  51. package/dist/src/cli/init.d.ts.map +1 -0
  52. package/dist/src/cli/lint.d.ts +11 -0
  53. package/dist/src/cli/lint.d.ts.map +1 -0
  54. package/dist/src/cli/modules.d.ts +3 -0
  55. package/dist/src/cli/modules.d.ts.map +1 -0
  56. package/dist/src/cli/shared.d.ts +6 -0
  57. package/dist/src/cli/shared.d.ts.map +1 -0
  58. package/dist/src/cli/site.d.ts +7 -0
  59. package/dist/src/cli/site.d.ts.map +1 -0
  60. package/dist/src/cli.d.ts +5 -0
  61. package/dist/src/cli.d.ts.map +1 -0
  62. package/dist/src/config/base.d.ts +4 -0
  63. package/dist/src/config/base.d.ts.map +1 -0
  64. package/dist/src/config/chunkCycles.d.ts +10 -0
  65. package/dist/src/config/chunkCycles.d.ts.map +1 -0
  66. package/dist/src/config/defaults.d.ts +4 -0
  67. package/dist/src/config/defaults.d.ts.map +1 -0
  68. package/dist/src/config/html.d.ts +3 -0
  69. package/dist/src/config/html.d.ts.map +1 -0
  70. package/dist/src/config/load.d.ts +20 -0
  71. package/dist/src/config/load.d.ts.map +1 -0
  72. package/dist/src/config/paths.d.ts +8 -0
  73. package/dist/src/config/paths.d.ts.map +1 -0
  74. package/dist/src/config/schema.d.ts +1238 -0
  75. package/dist/src/config/schema.d.ts.map +1 -0
  76. package/dist/src/config/viteConfig.d.ts +11 -0
  77. package/dist/src/config/viteConfig.d.ts.map +1 -0
  78. package/dist/src/dbml/erd.d.ts +59 -0
  79. package/dist/src/dbml/erd.d.ts.map +1 -0
  80. package/dist/src/framework/configStore.d.ts +7 -0
  81. package/dist/src/framework/configStore.d.ts.map +1 -0
  82. package/dist/src/framework/createNimpressApp.d.ts +10 -0
  83. package/dist/src/framework/createNimpressApp.d.ts.map +1 -0
  84. package/dist/src/framework/gated.d.ts +5 -0
  85. package/dist/src/framework/gated.d.ts.map +1 -0
  86. package/dist/src/framework/hashSpy.d.ts +7 -0
  87. package/dist/src/framework/hashSpy.d.ts.map +1 -0
  88. package/dist/src/framework/pageMeta.d.ts +4 -0
  89. package/dist/src/framework/pageMeta.d.ts.map +1 -0
  90. package/dist/src/framework/pageStyles.d.ts +2 -0
  91. package/dist/src/framework/pageStyles.d.ts.map +1 -0
  92. package/dist/src/framework/router.d.ts +5 -0
  93. package/dist/src/framework/router.d.ts.map +1 -0
  94. package/dist/src/framework/stores/feed.d.ts +8 -0
  95. package/dist/src/framework/stores/feed.d.ts.map +1 -0
  96. package/dist/src/framework/stores/sidebar.d.ts +4 -0
  97. package/dist/src/framework/stores/sidebar.d.ts.map +1 -0
  98. package/dist/src/framework/stores/theme.d.ts +6 -0
  99. package/dist/src/framework/stores/theme.d.ts.map +1 -0
  100. package/dist/src/framework/stores/viewer.d.ts +6 -0
  101. package/dist/src/framework/stores/viewer.d.ts.map +1 -0
  102. package/dist/src/icons/FullscreenIcon.svelte.d.ts +1 -0
  103. package/dist/src/icons/IconAdd.svelte.d.ts +1 -0
  104. package/dist/src/icons/IconChevron.svelte.d.ts +1 -0
  105. package/dist/src/icons/IconClear.svelte.d.ts +1 -0
  106. package/dist/src/icons/IconConsole.svelte.d.ts +1 -0
  107. package/dist/src/icons/IconDock.svelte.d.ts +1 -0
  108. package/dist/src/icons/IconDownload.svelte.d.ts +1 -0
  109. package/dist/src/icons/IconJson.svelte.d.ts +1 -0
  110. package/dist/src/icons/IconMinus.svelte.d.ts +1 -0
  111. package/dist/src/icons/IconMock.svelte.d.ts +1 -0
  112. package/dist/src/icons/IconMoon.svelte.d.ts +1 -0
  113. package/dist/src/icons/IconOpen.svelte.d.ts +1 -0
  114. package/dist/src/icons/IconReload.svelte.d.ts +1 -0
  115. package/dist/src/icons/IconRemove.svelte.d.ts +1 -0
  116. package/dist/src/icons/IconShadow.svelte.d.ts +1 -0
  117. package/dist/src/icons/IconSun.svelte.d.ts +1 -0
  118. package/dist/src/index.d.ts +44 -0
  119. package/dist/src/index.d.ts.map +1 -0
  120. package/dist/src/layout/App.svelte.d.ts +1 -0
  121. package/dist/src/layout/AppRoot.svelte.d.ts +1 -0
  122. package/dist/src/layout/BackToTop.svelte.d.ts +1 -0
  123. package/dist/src/layout/Breadcrumbs.svelte.d.ts +1 -0
  124. package/dist/src/layout/GatedPage.svelte.d.ts +1 -0
  125. package/dist/src/layout/Header.svelte.d.ts +1 -0
  126. package/dist/src/layout/HomePage.svelte.d.ts +1 -0
  127. package/dist/src/layout/RightToc.svelte.d.ts +1 -0
  128. package/dist/src/layout/Sidebar.svelte.d.ts +1 -0
  129. package/dist/src/layout/SidebarNode.svelte.d.ts +1 -0
  130. package/dist/src/markdown/Actions.svelte.d.ts +1 -0
  131. package/dist/src/markdown/CalloutCheck.svelte.d.ts +1 -0
  132. package/dist/src/markdown/CalloutInfo.svelte.d.ts +1 -0
  133. package/dist/src/markdown/CalloutNote.svelte.d.ts +1 -0
  134. package/dist/src/markdown/CalloutTip.svelte.d.ts +1 -0
  135. package/dist/src/markdown/CalloutWarning.svelte.d.ts +1 -0
  136. package/dist/src/markdown/Card.svelte.d.ts +1 -0
  137. package/dist/src/markdown/CardGroup.svelte.d.ts +1 -0
  138. package/dist/src/markdown/ChangelogPage.svelte.d.ts +1 -0
  139. package/dist/src/markdown/CodeBlock.svelte.d.ts +1 -0
  140. package/dist/src/markdown/CodeEditor.svelte.d.ts +1 -0
  141. package/dist/src/markdown/CodeGroup.svelte.d.ts +1 -0
  142. package/dist/src/markdown/ComponentEmbed.svelte.d.ts +1 -0
  143. package/dist/src/markdown/ComponentPage.svelte.d.ts +1 -0
  144. package/dist/src/markdown/ControlNode.svelte.d.ts +1 -0
  145. package/dist/src/markdown/DBMLBlock.svelte.d.ts +1 -0
  146. package/dist/src/markdown/DbmlNote.svelte.d.ts +1 -0
  147. package/dist/src/markdown/DbmlPage.svelte.d.ts +1 -0
  148. package/dist/src/markdown/DbmlTable.svelte.d.ts +1 -0
  149. package/dist/src/markdown/DragDivider.svelte.d.ts +1 -0
  150. package/dist/src/markdown/Feature.svelte.d.ts +1 -0
  151. package/dist/src/markdown/FeatureGrid.svelte.d.ts +1 -0
  152. package/dist/src/markdown/HeroPage.svelte.d.ts +1 -0
  153. package/dist/src/markdown/MermaidBlock.svelte.d.ts +1 -0
  154. package/dist/src/markdown/Page.svelte.d.ts +1 -0
  155. package/dist/src/markdown/PlanetFooter.svelte.d.ts +1 -0
  156. package/dist/src/markdown/RoadmapBlob.svelte.d.ts +1 -0
  157. package/dist/src/markdown/RoadmapNode.svelte.d.ts +1 -0
  158. package/dist/src/markdown/RoadmapPage.svelte.d.ts +1 -0
  159. package/dist/src/markdown/SubscribeDialog.svelte.d.ts +1 -0
  160. package/dist/src/mock/index.d.ts +42 -0
  161. package/dist/src/mock/index.d.ts.map +1 -0
  162. package/dist/src/modules/autoStory.d.ts +5 -0
  163. package/dist/src/modules/autoStory.d.ts.map +1 -0
  164. package/dist/src/modules/componentData.d.ts +14 -0
  165. package/dist/src/modules/componentData.d.ts.map +1 -0
  166. package/dist/src/modules/harness.d.ts +25 -0
  167. package/dist/src/modules/harness.d.ts.map +1 -0
  168. package/dist/src/modules/importStorybook.d.ts +12 -0
  169. package/dist/src/modules/importStorybook.d.ts.map +1 -0
  170. package/dist/src/modules/lint.d.ts +3 -0
  171. package/dist/src/modules/lint.d.ts.map +1 -0
  172. package/dist/src/modules/pages.d.ts +10 -0
  173. package/dist/src/modules/pages.d.ts.map +1 -0
  174. package/dist/src/modules/parse/dts.d.ts +4 -0
  175. package/dist/src/modules/parse/dts.d.ts.map +1 -0
  176. package/dist/src/modules/parse/svelte.d.ts +3 -0
  177. package/dist/src/modules/parse/svelte.d.ts.map +1 -0
  178. package/dist/src/modules/parse/typeMembers.d.ts +64 -0
  179. package/dist/src/modules/parse/typeMembers.d.ts.map +1 -0
  180. package/dist/src/modules/parse/vue.d.ts +3 -0
  181. package/dist/src/modules/parse/vue.d.ts.map +1 -0
  182. package/dist/src/modules/resolve.d.ts +9 -0
  183. package/dist/src/modules/resolve.d.ts.map +1 -0
  184. package/dist/src/modules/schema.d.ts +53 -0
  185. package/dist/src/modules/schema.d.ts.map +1 -0
  186. package/dist/src/modules/stories.d.ts +4 -0
  187. package/dist/src/modules/stories.d.ts.map +1 -0
  188. package/dist/src/search/SearchModal.svelte.d.ts +1 -0
  189. package/dist/src/search/indexer.d.ts +5 -0
  190. package/dist/src/search/indexer.d.ts.map +1 -0
  191. package/dist/src/story/index.d.ts +17 -0
  192. package/dist/src/story/index.d.ts.map +1 -0
  193. package/dist/src/subscribe/subscribe.d.ts +5 -0
  194. package/dist/src/subscribe/subscribe.d.ts.map +1 -0
  195. package/dist/src/types.d.ts +531 -0
  196. package/dist/src/types.d.ts.map +1 -0
  197. package/dist/story.es.js +10 -0
  198. package/dist/style.css +1 -0
  199. package/dist/tailwind.preset.d.ts +4 -0
  200. package/dist/tailwind.preset.d.ts.map +1 -0
  201. package/dist/tailwind.preset.es.js +67 -0
  202. package/dist/typeMembers-CNvE92EX.js +538 -0
  203. package/package.json +125 -0
  204. package/src/harness/svelte/ComponentHarness.svelte +12 -0
  205. package/src/harness/svelte/ComponentHarnessEffects.svelte +24 -0
  206. package/src/harness/svelte/ComponentHarnessOverlay.svelte +9 -0
  207. package/src/harness/svelte/ComponentStory.svelte +9 -0
  208. package/src/harness/svelte/DefaultHarness.svelte +15 -0
  209. package/src/harness/svelte/HarnessRoot.svelte +22 -0
  210. package/src/harness/svelte/context.svelte.ts +33 -0
  211. package/src/harness/svelte/index.ts +12 -0
  212. package/src/harness/vue/ComponentHarness.vue +16 -0
  213. package/src/harness/vue/ComponentHarnessEffects.vue +27 -0
  214. package/src/harness/vue/ComponentHarnessOverlay.vue +12 -0
  215. package/src/harness/vue/ComponentStory.vue +16 -0
  216. package/src/harness/vue/DefaultHarness.vue +14 -0
  217. package/src/harness/vue/context.ts +37 -0
  218. package/src/harness/vue/index.ts +11 -0
  219. package/src/mock/index.ts +88 -0
  220. package/src/styles/app.css +3 -0
  221. package/src/styles/preflight.css +540 -0
  222. package/src/styles/theme.css +81 -0
  223. package/src/styles/tokens.css +150 -0
@@ -0,0 +1,154 @@
1
+ # Authoring roadmap pages
2
+
3
+ Rules for the `type: roadmap` page and the issue pages that fill its timeline.
4
+
5
+ ## Two file types
6
+
7
+ 1. One `type: roadmap` file per roadmap. Its filename is arbitrary. It defines the header markdown, hero text, and background of the roadmap page itself.
8
+
9
+ 2. Many sibling files of `type: milestone | epic | feature | bug`. Each is a real standalone page at its own URL. Collectively call these issue pages.
10
+
11
+ The plugin discovers a roadmap by walking the content tree and finding any file whose frontmatter declares `type: roadmap`. Each such file produces one roadmap page in the sidebar. Multiple roadmap files in different folders produce independent roadmaps.
12
+
13
+ ## Layout in the file tree
14
+
15
+ ```
16
+ docs/
17
+ └── solutions/
18
+ └── bookable/
19
+ └── roadmap/
20
+ ├── overview.md # type: roadmap, header markdown lives here
21
+ ├── public-booking-calendar.md # type: epic
22
+ ├── notification-routing.md # type: feature
23
+ └── api-error-mapping.md # type: bug
24
+ ```
25
+
26
+ By default the roadmap pulls issue pages from the same folder as the roadmap file. Override the scope with `data.issues` or `data.entries` (relative paths or array of paths) on the roadmap file to point at one or more subfolders.
27
+
28
+ ## Filenames are the ids
29
+
30
+ Filename without `.md` is the issue id. References from `data.parent` on issues and `data.issue` on changelog entries are written as relative paths (with or without `.md`).
31
+
32
+ There is no `data.id` field. Do not invent one.
33
+
34
+ ## Roadmap file frontmatter
35
+
36
+ ```yaml
37
+ ---
38
+ title: Bookable roadmap
39
+ type: roadmap
40
+ description: What we are building, what we are shipping, and what is on the horizon.
41
+ background: /img/roadmap-bg.svg
42
+ data:
43
+ changelog: ../changelog
44
+ ---
45
+ ```
46
+
47
+ 1. `title` is the page title. The roadmap file's markdown body renders as the page header above the timeline.
48
+
49
+ 2. `data.changelog` is optional. A relative path to a changelog folder whose entries should plot markers on the spine and feed the rocket progress. Omit to auto-discover from any changelog that links into one of this roadmap's issues via `data.issue`. Explicit scope takes priority when set.
50
+
51
+ 3. `data.issues` or `data.entries` is optional. A relative path or array of paths. The roadmap pulls issue pages from these directories instead of the default sibling scope.
52
+
53
+ ## Issue file frontmatter
54
+
55
+ ```yaml
56
+ ---
57
+ title: Public booking calendar surface
58
+ type: epic
59
+ description: A customer facing booking calendar that runs end to end on mobile and desktop web.
60
+ data:
61
+ date: 2026-08-21
62
+ parent: organization-settings
63
+ ---
64
+ ```
65
+
66
+ 1. `title` is required.
67
+
68
+ 2. `type` must be one of `milestone | epic | feature | bug`. The renderer paints the card and the issue page chrome differently per kind.
69
+
70
+ 3. `description` is one short sentence. Plain text. Shown on the timeline card and on the hover aside.
71
+
72
+ 4. `data.date` is required. An RFC 3339 date or full timestamp. Drives the chronological position on the spine and the sidebar order (oldest at top).
73
+
74
+ 5. `data.parent` is optional. The filename (with or without `.md`) of another issue in the same roadmap. The renderer pairs the child next to its parent on the timeline. The sidebar nests the child under the parent.
75
+
76
+ ## Changelog linkage
77
+
78
+ A changelog entry opts in to an issue with `data.issue: <relative path>` and reports its effect on the issue with `data.status`. The plugin resolves the path against the changelog file's directory.
79
+
80
+ ```yaml
81
+ data:
82
+ version: 1.5.0
83
+ release_date: 2026-06-10
84
+ title: Calendar selection surface
85
+ description: Plain text sentence.
86
+ issue: ../roadmap/public-booking-calendar
87
+ status: 60
88
+ ```
89
+
90
+ 1. `data.issue` is a relative path to the issue file. The resolved file must exist as a roadmap issue, or the link is dropped.
91
+
92
+ 2. `data.status` is one of:
93
+
94
+ 2.1. A number `0..100`. The percent of the issue this release advanced. The highest number across all linked releases sets the rocket position.
95
+
96
+ 2.2. The literal word `completes` (also accepts `completed`, `complete`, `closes`, `fixes`, `resolves`). The issue flips to `shipped` and the rocket settles at this point. Use the verb that matches your commit and PR style.
97
+
98
+ 3. The release lands a marker on the roadmap spine at the changelog `release_date`. Clicking the marker navigates to the changelog entry's URL.
99
+
100
+ ## Card and timeline
101
+
102
+ 1. Cards alternate left and right of the spine by default. Issues with a `data.parent` sit next to their parent in chronological order.
103
+
104
+ 2. Each card carries the `KIND` label as a solid colored pill at the top-left and the target date at the top-right. Title below, description below that. The kind pill is indigo for epic, green for feature, red for bug.
105
+
106
+ 3. The card border color carries the issue status. Green for shipped, yellow for in progress, the default border for planned. Status is driven by the linked changelog `data.status`, so authors set status through the changelog, not on the issue file.
107
+
108
+ 4. Card backgrounds are organic SVG blobs deterministically generated from the filename, so each card looks unique but stays stable.
109
+
110
+ 5. The spine is a single smooth curve from the planet at the bottom to an arrow at the top. The arc length between two consecutive issues scales with the time between them, so a long gap draws a longer stretch of path. The traveled portion is solid, the untraveled portion is dashed and muted, matching the top arrow.
111
+
112
+ 6. Today renders as a short tick drawn as a normal to the path, carrying a date-only label placed on the side away from the nearest issue. An SVG rocket sits at the chronological position of today, or at the highest linked changelog progress, whichever is further.
113
+
114
+ 7. Every linked changelog entry drops a smaller dotted marker with the version and release date at its release-date position. Clicking the marker navigates to the changelog entry.
115
+
116
+ 8. Clicking a card navigates to the issue's own page (each issue is a real standalone page at its file URL).
117
+
118
+ ## Responsive
119
+
120
+ 1. At 800px viewport width and below, every issue moves into a single column on the right, ordered by date with the oldest at the bottom.
121
+
122
+ 2. The spine becomes a straight vertical line on the left. It starts at the globe at the bottom, curls to the left, and runs straight up to the top arrow. Each card connects to the line with a horizontal connector.
123
+
124
+ 3. The hover aside is off at this width. Tapping a card navigates to its page.
125
+
126
+ ## Hover aside
127
+
128
+ 1. Desktop (above 900px viewport): hovering or focusing a card opens a floating aside on the opposite side that mirrors the issue's markdown body and lists the shipping changelogs. Mobile (≤900px): no hover; tap navigates.
129
+
130
+ ## Sidebar
131
+
132
+ 1. The roadmap page is the parent node.
133
+
134
+ 2. Issue pages list as children sorted by `data.date` ascending (oldest first, newest last).
135
+
136
+ 3. Children with `data.parent` nest under the parent issue in the sidebar.
137
+
138
+ 4. Each issue page has its own URL and renders through the standard page chrome with a kind chip and date header.
139
+
140
+ 5. Each row carries an icon for its kind: a flag for milestone, a box for epic, a sparkle for feature, an alert for bug. The icons live in `issueKindIcon` in `src/plugin.ts` and are not authored per page.
141
+
142
+ ## Right TOC
143
+
144
+ 1. The roadmap page itself has no right TOC.
145
+
146
+ 2. Issue pages keep the right TOC like regular doc pages.
147
+
148
+ ## What not to include
149
+
150
+ 1. Internal status updates better suited to issue comments.
151
+
152
+ 2. Customer names or contracts. The roadmap page is customer facing.
153
+
154
+ 3. Pricing or dates that are not yet committed publicly.
@@ -0,0 +1,61 @@
1
+ # Styling and theming
2
+
3
+ Rules for changing how Nimpress looks, both inside the framework and inside consumer overrides.
4
+
5
+ ## Token first
6
+
7
+ Every visual choice goes through a CSS custom property. Token catalog lives in `src/styles/tokens.css`. Before touching a component's CSS, check whether a token already covers it.
8
+
9
+ ## When to add a token
10
+
11
+ 1. The value appears in more than one component.
12
+
13
+ 2. Consumers will want to override it without forking.
14
+
15
+ 3. It has light and dark variants.
16
+
17
+ If none of those apply, keep the literal value in the component.
18
+
19
+ ## Class naming
20
+
21
+ 1. Every component root carries a stable `np-<scope>` class.
22
+
23
+ 2. Internal elements carry `np-<scope>-<part>` classes.
24
+
25
+ 3. The class set on rendered chrome is the public API. Renames go through a major version bump.
26
+
27
+ ## Overrides from consumers
28
+
29
+ Consumers override Nimpress styles by:
30
+
31
+ 1. A site wide stylesheet named in the `css` config field. nimpress loads it after the framework styles, so setting CSS custom properties on `:root` and `html.dark` or targeting the public `np-` classes there wins the cascade.
32
+
33
+ 2. A per page stylesheet named the same as a markdown file. `guide/index.css` next to `guide/index.md` loads while the route is `/guide` or any path under it. A leaf page's stylesheet loads only on its own page. The author writes normal selectors and they apply only while inside that subtree.
34
+
35
+ 3. A css file that is not a page style, such as a story asset loaded with `?raw`, is named with a leading underscore, `template/_cv.css`. Lint treats underscore css as inert; any other css file must sit next to the markdown page it is named after.
36
+
37
+ Consumers never need to fork the framework to change visuals.
38
+
39
+ ## Light and dark
40
+
41
+ Every token has a light and a dark value. Adding a token means adding both. Tokens without a dark variant break the theme toggle.
42
+
43
+ ## Geometry tokens
44
+
45
+ 1. `--np-radius-sm`, `--np-radius-md`, `--np-radius-lg`, `--np-radius-pill` for rounded corners. Pick the smallest one that reads correctly.
46
+
47
+ 2. `--np-header-height`, `--np-sidebar-width`, `--np-toc-width`, `--np-content-max` for layout. Sticky positioning math depends on these. Do not bypass them with hardcoded pixels.
48
+
49
+ ## Spacing
50
+
51
+ No spacing token system. Spacing is per component. Keep values to multiples of 4px for visual rhythm.
52
+
53
+ ## Don't
54
+
55
+ 1. Do not write component scoped styles in `tokens.css`. Tokens describe values, not components.
56
+
57
+ 2. Do not introduce a CSS preprocessor. Vanilla CSS only.
58
+
59
+ 3. Do not introduce a CSS in JS library. Svelte's scoped `<style>` is the carrier.
60
+
61
+ 4. Do not add `!important`. If you reach for it, the cascade is fighting your structure, fix the structure.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 nimling
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,137 @@
1
+ <div align="center">
2
+ <img src="assets/logo.svg" alt="Nimpress" width="320" />
3
+
4
+ <span><i>Svelte 5 docs framework that supports it all.</i></span>
5
+ </div>
6
+
7
+ ## Documentation
8
+
9
+ The full documentation is at **[nimling.github.io/nimpress](https://nimling.github.io/nimpress/)**. It is built from the `docs/` folder of this repository with nimpress itself and redeploys on every release, so it is always the current reference. This file stays short and points there.
10
+
11
+ | Topic | Guide |
12
+ |-------|-------|
13
+ | Getting started, config, first site | [Getting started](https://nimling.github.io/nimpress/getting-started) |
14
+ | CLI reference: every command, flag, and exit code | [CLI](https://nimling.github.io/nimpress/cli) |
15
+ | Page types: `doc`, `openapi`, `changelog`, `hero`, `roadmap`, `dbml`, `component` | [Page types](https://nimling.github.io/nimpress/page-types) |
16
+ | Component workshop: systems, stories, harness, controls, import CLI | [Modules](https://nimling.github.io/nimpress/modules) |
17
+ | Markdown support, callouts, actions, features | [Markdown](https://nimling.github.io/nimpress/markdown) |
18
+ | Definition lists for compact term references | [Definition lists](https://nimling.github.io/nimpress/definition-lists) |
19
+ | Mermaid diagrams | [Mermaid](https://nimling.github.io/nimpress/mermaid) |
20
+ | DBML database diagrams | [DBML](https://nimling.github.io/nimpress/dbml) |
21
+ | OpenAPI renderer | [OpenAPI](https://nimling.github.io/nimpress/openapi) |
22
+ | Changelog renderer | [Changelog renderer](https://nimling.github.io/nimpress/changelog-renderer) |
23
+ | Hero landing pages | [Hero](https://nimling.github.io/nimpress/hero) |
24
+ | SEO and social cards | [SEO](https://nimling.github.io/nimpress/seo) |
25
+ | Build pipeline, build outputs, shell and body split | [Build pipeline](https://nimling.github.io/nimpress/build-pipeline) |
26
+ | Relative links between pages | [Relative links](https://nimling.github.io/nimpress/relative-links) |
27
+ | Frontmatter reference | [Frontmatter](https://nimling.github.io/nimpress/frontmatter) |
28
+ | Sidebar layout from the content tree | [Sidebar](https://nimling.github.io/nimpress/sidebar) |
29
+ | Theming and overriding styles | [Theming](https://nimling.github.io/nimpress/theming) |
30
+ | Auth and the gate guard flow | [Auth](https://nimling.github.io/nimpress/auth) |
31
+ | Search index | [Search](https://nimling.github.io/nimpress/search) |
32
+ | Publishing docs to a central site, the sync actions, and their secrets | [Pipeline](https://nimling.github.io/nimpress/actions) |
33
+ | Every release | [Releases](https://nimling.github.io/nimpress/changelog/) |
34
+
35
+ ## Getting started
36
+
37
+ ```bash
38
+ pnpm add @nimtech/nimpress
39
+ ```
40
+
41
+ `@nimtech/nimpress` is public on npm. No `.npmrc`, no registry line, no token. It just works.
42
+
43
+ ## Set up a site
44
+
45
+ A consumer needs one config file and the `nimpress` CLI. The CLI owns Vite, serves the app shell and entry as virtual modules, and reads `nimpress.config`. There is no Vite config to write and no app to mount by hand.
46
+
47
+ ```bash
48
+ pnpm exec nimpress init
49
+ ```
50
+
51
+ That writes a starter `nimpress.config.ts` and a content folder:
52
+
53
+ ```ts
54
+ import { defineConfig } from '@nimtech/nimpress/plugin'
55
+
56
+ export default defineConfig({
57
+ title: 'Docs',
58
+ logo: '/assets/logo.png',
59
+ github: 'https://github.com/nimling/your-repo',
60
+ contentDir: 'docs'
61
+ })
62
+ ```
63
+
64
+ Every field has a default, so a config can be as small as a title. Wire the CLI into `package.json`:
65
+
66
+ ```json
67
+ {
68
+ "scripts": {
69
+ "dev": "nimpress dev",
70
+ "build": "nimpress build",
71
+ "lint": "nimpress lint"
72
+ }
73
+ }
74
+ ```
75
+
76
+ The rest of the config surface, every command, and the build outputs are covered in [Getting started](https://nimling.github.io/nimpress/getting-started) and the [CLI reference](https://nimling.github.io/nimpress/cli).
77
+
78
+ ## Authoring docs with Claude
79
+
80
+ The package ships the authoring rules at `node_modules/@nimtech/nimpress/.claude/rules/`. They cover how to write each page type: docs, changelog entries, hero pages, roadmap pages, roadmap issues, and dbml pages, plus frontmatter, file layout, and styling.
81
+
82
+ Claude does not auto load rules from inside `node_modules`, so `nimpress init` writes a `CLAUDE.md` and an `AGENTS.md` pointing at them. In a repo that adds nimpress by hand, add the pointer yourself:
83
+
84
+ ```md
85
+ ## Nimpress docs authoring
86
+
87
+ When writing or editing markdown under the docs content directory, follow the Nimpress authoring rules in `node_modules/@nimtech/nimpress/.claude/rules/`. Read the rule that matches the page type before writing:
88
+
89
+ - `docs-authoring.md`, `doc-pages.md`, `page-types.md`, `frontmatter.md`, `file-layout.md` for general pages
90
+ - `changelog-entries.md` for changelog entries
91
+ - `roadmap-entries.md` for roadmap pages and issue pages
92
+ - `dbml-pages.md` for database diagram pages and inline dbml fences
93
+ - `component-modules.md` for component pages, stories, and the workshop
94
+ - `style.md` for theming and overrides
95
+ ```
96
+
97
+ ## Working on Nimpress itself
98
+
99
+ | Command | Description |
100
+ |---------|-------------|
101
+ | `just install` | Install dependencies with pnpm |
102
+ | `just build` | Build the library bundle into `dist/` |
103
+ | `just check` | Run svelte-check and tsc |
104
+ | `just test` | Run the actions go tests, the CLI vitest suite, and the type checks |
105
+ | `just dev` | Serve this repo's `docs/` with a watching library rebuild |
106
+ | `just site` | Build this repo's `docs/` into `dist/site` |
107
+ | `just deploy` | Patch version bump, tag, and trigger the publish workflows |
108
+ | `just deploy-minor` | Minor version bump and publish |
109
+ | `just deploy-major` | Major version bump and publish |
110
+
111
+ A version tag publishes the package to npm, deploys `docs/` to GitHub Pages, and moves the major tag on the actions.
112
+
113
+ ## Structure
114
+
115
+ ```
116
+ nimpress/
117
+ ├── assets/ Logo and brand artwork
118
+ ├── bin/nimpress.mjs CLI entry
119
+ ├── docs/ The documentation site, built and published on every release
120
+ ├── actions/ Cross repo docs sync GitHub Actions
121
+ ├── src/
122
+ │ ├── index.ts Public Svelte exports
123
+ │ ├── plugin.ts Vite plugin and defineConfig
124
+ │ ├── cli.ts CLI dispatch
125
+ │ ├── cli/ One module per command: init, lint, site, guard, export, modules
126
+ │ ├── config/ Config load, defaults, schema, Vite and html
127
+ │ ├── framework/ App bootstrap, router, stores
128
+ │ ├── layout/ Shell, header, sidebar, breadcrumbs, right TOC
129
+ │ ├── markdown/ Page, ChangelogPage, HeroPage, DbmlPage, callouts, code blocks
130
+ │ ├── api/ OpenAPI renderer
131
+ │ ├── dbml/ DBML to diagram model conversion, run at build time
132
+ │ ├── search/ MiniSearch wrapper and modal
133
+ │ ├── auth/ Session login guard
134
+ │ └── styles/ Tokens and preflight
135
+ ├── tailwind.preset.ts Design tokens exported for consumers
136
+ └── justfile Task runner
137
+ ```
@@ -0,0 +1,7 @@
1
+ #!/usr/bin/env node
2
+ import { run } from '../dist/cli.es.js'
3
+
4
+ run(process.argv.slice(2)).catch((err) => {
5
+ console.error(err)
6
+ process.exit(1)
7
+ })