pict-section-inlinedocumentation 1.0.0 → 1.0.2

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 (41) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +11 -13
  3. package/diagrams/four-levels-of-embeddedness.excalidraw +717 -0
  4. package/diagrams/four-levels-of-embeddedness.mmd +4 -0
  5. package/diagrams/four-levels-of-embeddedness.svg +2 -0
  6. package/docs/README.md +10 -19
  7. package/docs/_brand.json +18 -0
  8. package/docs/_cover.md +6 -0
  9. package/docs/_sidebar.md +8 -4
  10. package/docs/_version.json +3 -3
  11. package/docs/architecture.md +2 -44
  12. package/docs/diagrams/component-diagram.excalidraw +3546 -0
  13. package/docs/diagrams/component-diagram.mmd +42 -0
  14. package/docs/diagrams/component-diagram.svg +2 -0
  15. package/docs/diagrams/four-levels-of-embeddedness.excalidraw +717 -0
  16. package/docs/diagrams/four-levels-of-embeddedness.mmd +9 -0
  17. package/docs/diagrams/four-levels-of-embeddedness.svg +2 -0
  18. package/docs/diagrams/project-layout.excalidraw +6082 -0
  19. package/docs/diagrams/project-layout.mmd +25 -0
  20. package/docs/diagrams/project-layout.svg +2 -0
  21. package/docs/embedding-level2-routes.md +1 -1
  22. package/docs/embedding-level4-autogen.md +1 -1
  23. package/docs/examples/README.md +9 -0
  24. package/docs/examples/bookshop/README.md +582 -0
  25. package/docs/examples/bookshop/bookshop_example.js +4519 -0
  26. package/docs/examples/bookshop/index.html +236 -0
  27. package/docs/index.html +6 -7
  28. package/docs/overview.md +4 -4
  29. package/docs/reference.md +2 -27
  30. package/docs/retold-catalog.json +77 -178
  31. package/docs/retold-keyword-index.json +14134 -1917
  32. package/example_applications/basic/docs/_brand.json +18 -0
  33. package/example_applications/bookshop/docs/_brand.json +18 -0
  34. package/example_applications/bookshop/package.json +9 -1
  35. package/package.json +9 -9
  36. package/source/providers/Pict-Provider-InlineDocumentation.js +27 -3
  37. package/source/views/Pict-View-InlineDocumentation-Content.js +19 -15
  38. package/source/views/Pict-View-InlineDocumentation-Layout.js +115 -3
  39. package/source/views/Pict-View-InlineDocumentation-Nav.js +98 -17
  40. package/source/views/Pict-View-InlineDocumentation-TopicManager.js +18 -18
  41. package/docs/css/docuserve.css +0 -327
@@ -65,8 +65,8 @@ const _ViewConfiguration =
65
65
  }
66
66
  .pict-inline-doc-tm-action-btn.danger:hover {
67
67
  background: var(--theme-color-background-tertiary, #FDE8E8);
68
- border-color: #E57373;
69
- color: #C62828;
68
+ border-color: var(--theme-color-status-error, #E57373);
69
+ color: var(--theme-color-status-error, #C62828);
70
70
  }
71
71
  .pict-inline-doc-tm-new-topic {
72
72
  display: flex;
@@ -74,7 +74,7 @@ const _ViewConfiguration =
74
74
  justify-content: center;
75
75
  padding: 0.7em;
76
76
  margin-top: 0.5em;
77
- border: 1px dashed #DDD6CA;
77
+ border: 1px dashed var(--theme-color-border-default, #DDD6CA);
78
78
  border-radius: 4px;
79
79
  color: var(--theme-color-brand-primary, #2E7D74);
80
80
  font-size: 0.9em;
@@ -83,7 +83,7 @@ const _ViewConfiguration =
83
83
  transition: background 0.1s, border-color 0.1s;
84
84
  }
85
85
  .pict-inline-doc-tm-new-topic:hover {
86
- background: #F0F9F7;
86
+ background: var(--theme-color-background-hover, #F0F9F7);
87
87
  border-color: var(--theme-color-brand-primary, #2E7D74);
88
88
  }
89
89
  .pict-inline-doc-tm-empty {
@@ -141,7 +141,7 @@ const _ViewConfiguration =
141
141
  display: inline-flex;
142
142
  align-items: center;
143
143
  padding: 0.2em 0.5em;
144
- background: #E8E3D8;
144
+ background: var(--theme-color-background-hover, #E8E3D8);
145
145
  border-radius: 12px;
146
146
  font-size: 0.82em;
147
147
  color: var(--theme-color-text-primary, #3D3229);
@@ -155,7 +155,7 @@ const _ViewConfiguration =
155
155
  line-height: 1;
156
156
  }
157
157
  .pict-inline-doc-tm-route-chip-remove:hover {
158
- color: #C62828;
158
+ color: var(--theme-color-status-error, #C62828);
159
159
  }
160
160
  .pict-inline-doc-tm-route-actions {
161
161
  display: flex;
@@ -182,7 +182,7 @@ const _ViewConfiguration =
182
182
  color: var(--theme-color-brand-primary, #2E7D74);
183
183
  }
184
184
  .pict-inline-doc-tm-route-action-btn.accent:hover {
185
- background: #F0F9F7;
185
+ background: var(--theme-color-background-hover, #F0F9F7);
186
186
  }
187
187
  .pict-inline-doc-tm-route-input-row {
188
188
  display: none;
@@ -244,11 +244,11 @@ const _ViewConfiguration =
244
244
  }
245
245
  .pict-inline-doc-tm-wc-segment:hover {
246
246
  border-color: var(--theme-color-brand-primary, #2E7D74);
247
- background: #F0F9F7;
247
+ background: var(--theme-color-background-hover, #F0F9F7);
248
248
  }
249
249
  .pict-inline-doc-tm-wc-segment.selected {
250
- background: #2E7D74;
251
- color: var(--theme-color-background-panel, #fff);
250
+ background: var(--theme-color-brand-primary, #2E7D74);
251
+ color: var(--theme-color-text-on-brand, #fff);
252
252
  border-color: var(--theme-color-brand-primary, #2E7D74);
253
253
  }
254
254
  .pict-inline-doc-tm-wc-segment.after-wildcard {
@@ -257,7 +257,7 @@ const _ViewConfiguration =
257
257
  cursor: default;
258
258
  }
259
259
  .pict-inline-doc-tm-wc-segment.after-wildcard:hover {
260
- border-color: #DDD6CA;
260
+ border-color: var(--theme-color-border-default, #DDD6CA);
261
261
  background: var(--theme-color-background-panel, #fff);
262
262
  }
263
263
  .pict-inline-doc-tm-wc-wildcard-star {
@@ -312,12 +312,12 @@ const _ViewConfiguration =
312
312
  background: var(--theme-color-background-secondary, #F5F0E8);
313
313
  }
314
314
  .pict-inline-doc-tm-bind-topic-option.selected {
315
- background: #F0F9F7;
315
+ background: var(--theme-color-background-hover, #F0F9F7);
316
316
  }
317
317
  .pict-inline-doc-tm-bind-radio {
318
318
  width: 16px;
319
319
  height: 16px;
320
- border: 2px solid #DDD6CA;
320
+ border: 2px solid var(--theme-color-border-default, #DDD6CA);
321
321
  border-radius: 50%;
322
322
  margin-right: 0.6em;
323
323
  flex-shrink: 0;
@@ -333,7 +333,7 @@ const _ViewConfiguration =
333
333
  left: 3px;
334
334
  width: 6px;
335
335
  height: 6px;
336
- background: #2E7D74;
336
+ background: var(--theme-color-brand-primary, #2E7D74);
337
337
  border-radius: 50%;
338
338
  }
339
339
  .pict-inline-doc-tm-bind-route-type {
@@ -357,8 +357,8 @@ const _ViewConfiguration =
357
357
  background: var(--theme-color-background-tertiary, #F0ECE4);
358
358
  }
359
359
  .pict-inline-doc-tm-bind-route-type-btn.selected {
360
- background: #2E7D74;
361
- color: var(--theme-color-background-panel, #fff);
360
+ background: var(--theme-color-brand-primary, #2E7D74);
361
+ color: var(--theme-color-text-on-brand, #fff);
362
362
  border-color: var(--theme-color-brand-primary, #2E7D74);
363
363
  }
364
364
  .pict-inline-doc-tm-sidebar-list {
@@ -383,7 +383,7 @@ const _ViewConfiguration =
383
383
  margin-left: 0.5em;
384
384
  }
385
385
  .pict-inline-doc-tm-validation-error {
386
- color: #C62828;
386
+ color: var(--theme-color-status-error, #C62828);
387
387
  font-size: 0.8em;
388
388
  margin-top: 0.3em;
389
389
  }
@@ -1440,7 +1440,7 @@ class InlineDocumentationTopicManagerView extends libPictView
1440
1440
  tmpHTML += '<div class="pict-inline-doc-tm-bind-topic-option" data-topic-code="__NEW__">';
1441
1441
  tmpHTML += '<div class="pict-inline-doc-tm-bind-radio"></div>';
1442
1442
  tmpHTML += '<div class="pict-inline-doc-tm-topic-info">';
1443
- tmpHTML += '<div class="pict-inline-doc-tm-topic-title" style="color:#2E7D74;">+ Create New Topic</div>';
1443
+ tmpHTML += '<div class="pict-inline-doc-tm-topic-title" style="color:var(--theme-color-brand-primary, #2E7D74);">+ Create New Topic</div>';
1444
1444
  tmpHTML += '</div>';
1445
1445
  tmpHTML += '</div>';
1446
1446
 
@@ -1,327 +0,0 @@
1
- /* ============================================================================
2
- Pict Docuserve - Base Styles & Theme Variables
3
- ============================================================================ */
4
-
5
- /* ----------------------------------------------------------------------------
6
- Theme variables — light defaults on :root.
7
- Dark mode applies when either:
8
- (a) the user explicitly selected dark via <html data-theme="dark">
9
- (b) the user hasn't chosen anything AND the system prefers dark
10
- An explicit <html data-theme="light"> pins the light palette regardless.
11
- ---------------------------------------------------------------------------- */
12
-
13
- :root
14
- {
15
- /* Surfaces */
16
- --docuserve-bg: #FDFBF7;
17
- --docuserve-bg-elevated: #FFFFFF;
18
- --docuserve-border: #DDD6CA;
19
- --docuserve-border-soft: #EAE3D8;
20
-
21
- /* Text */
22
- --docuserve-text: #2A241E;
23
- --docuserve-text-strong: #3D3229;
24
- --docuserve-text-muted: #5E5549;
25
- --docuserve-text-dim: #8A7F72;
26
-
27
- /* Accent / links */
28
- --docuserve-accent: #2E7D74;
29
- --docuserve-accent-hover: #236660;
30
-
31
- /* Top bar */
32
- --docuserve-topbar-bg: #3D3229;
33
- --docuserve-topbar-text: #E8E0D4;
34
- --docuserve-topbar-text-muted: #B5AA9A;
35
- --docuserve-topbar-text-dim: #8A7F72;
36
- --docuserve-topbar-hover-bg: #524438;
37
- --docuserve-topbar-version-bg: rgba(255, 255, 255, 0.06);
38
- --docuserve-topbar-version-border: rgba(255, 255, 255, 0.08);
39
- --docuserve-topbar-version-text: #B5AA9A;
40
-
41
- /* Sidebar */
42
- --docuserve-sidebar-bg: #FAF7F1;
43
- --docuserve-sidebar-border: #DDD6CA;
44
- --docuserve-sidebar-border-soft: #E5DED1;
45
- --docuserve-sidebar-text: #423D37;
46
- --docuserve-sidebar-group-title: #3D3229;
47
- --docuserve-sidebar-module-text: #5E5549;
48
- --docuserve-sidebar-hover-bg: #EAE3D8;
49
- --docuserve-sidebar-hover-text: #2E7D74;
50
- --docuserve-sidebar-active-bg: #E5DED1;
51
- --docuserve-sidebar-active-text: #2E7D74;
52
- --docuserve-sidebar-search-bg: #FFFFFF;
53
- --docuserve-sidebar-search-border: #DDD6CA;
54
-
55
- /* Inline code */
56
- --docuserve-inline-code-bg: #F0ECE4;
57
- --docuserve-inline-code-text: #9E3A50;
58
-
59
- /* Code block panel */
60
- --docuserve-code-bg: #F6F3EE;
61
- --docuserve-code-border: #E5DED1;
62
- --docuserve-code-gutter-bg: #EFEAE0;
63
- --docuserve-code-gutter-border: #DDD6CA;
64
- --docuserve-code-gutter-text: #A59986;
65
- --docuserve-code-text: #2A241E;
66
-
67
- /* Syntax tokens — low-chroma dark-on-light palette */
68
- --docuserve-tok-keyword: #A03472;
69
- --docuserve-tok-string: #1A6640;
70
- --docuserve-tok-number: #B25A00;
71
- --docuserve-tok-comment: #8A7F72;
72
- --docuserve-tok-operator: #2E7D74;
73
- --docuserve-tok-punctuation: #2A241E;
74
- --docuserve-tok-function: #2A5DB0;
75
- --docuserve-tok-property: #9E3A50;
76
- --docuserve-tok-tag: #9E3A50;
77
- --docuserve-tok-attr-name: #B25A00;
78
- --docuserve-tok-attr-value: #1A6640;
79
-
80
- /* Tables, blockquotes, mermaid */
81
- --docuserve-table-header-bg: #F5F0E8;
82
- --docuserve-table-row-alt-bg: #F9F6F0;
83
- --docuserve-blockquote-bg: #F7F5F0;
84
- --docuserve-blockquote-border: #2E7D74;
85
- --docuserve-blockquote-text: #5E5549;
86
- --docuserve-mermaid-bg: #FFFFFF;
87
-
88
- /* Scrollbars */
89
- --docuserve-scrollbar-track: #F5F0E8;
90
- --docuserve-scrollbar-thumb: #D4CCBE;
91
- --docuserve-scrollbar-thumb-hover: #B5AA9A;
92
- }
93
-
94
- @media (prefers-color-scheme: dark)
95
- {
96
- :root:not([data-theme="light"])
97
- {
98
- --docuserve-bg: #15120F;
99
- --docuserve-bg-elevated: #1B1814;
100
- --docuserve-border: #2F2823;
101
- --docuserve-border-soft: #26211C;
102
-
103
- --docuserve-text: #E8E0D4;
104
- --docuserve-text-strong: #F2ECE0;
105
- --docuserve-text-muted: #B5AA9A;
106
- --docuserve-text-dim: #7A6F62;
107
-
108
- --docuserve-accent: #5DB8A8;
109
- --docuserve-accent-hover: #7FCCB8;
110
-
111
- --docuserve-topbar-bg: #1A1612;
112
- --docuserve-topbar-text: #E8E0D4;
113
- --docuserve-topbar-text-muted: #B5AA9A;
114
- --docuserve-topbar-text-dim: #7A6F62;
115
- --docuserve-topbar-hover-bg: #2A241E;
116
- --docuserve-topbar-version-bg: rgba(255, 255, 255, 0.05);
117
- --docuserve-topbar-version-border: rgba(255, 255, 255, 0.09);
118
- --docuserve-topbar-version-text: #B5AA9A;
119
-
120
- --docuserve-sidebar-bg: #1B1814;
121
- --docuserve-sidebar-border: #2F2823;
122
- --docuserve-sidebar-border-soft: #26211C;
123
- --docuserve-sidebar-text: #C9C0B3;
124
- --docuserve-sidebar-group-title: #F2ECE0;
125
- --docuserve-sidebar-module-text: #B5AA9A;
126
- --docuserve-sidebar-hover-bg: #2A241E;
127
- --docuserve-sidebar-hover-text: #7FCCB8;
128
- --docuserve-sidebar-active-bg: #2F2823;
129
- --docuserve-sidebar-active-text: #7FCCB8;
130
- --docuserve-sidebar-search-bg: #26211C;
131
- --docuserve-sidebar-search-border: #2F2823;
132
-
133
- --docuserve-inline-code-bg: #2A241E;
134
- --docuserve-inline-code-text: #E8B07A;
135
-
136
- --docuserve-code-bg: #1E1A17;
137
- --docuserve-code-border: #2F2823;
138
- --docuserve-code-gutter-bg: #17130F;
139
- --docuserve-code-gutter-border: #2F2823;
140
- --docuserve-code-gutter-text: #6A6052;
141
- --docuserve-code-text: #E8E0D4;
142
-
143
- --docuserve-tok-keyword: #C678DD;
144
- --docuserve-tok-string: #98C379;
145
- --docuserve-tok-number: #D19A66;
146
- --docuserve-tok-comment: #7F848E;
147
- --docuserve-tok-operator: #56B6C2;
148
- --docuserve-tok-punctuation: #E8E0D4;
149
- --docuserve-tok-function: #61AFEF;
150
- --docuserve-tok-property: #E06C75;
151
- --docuserve-tok-tag: #E06C75;
152
- --docuserve-tok-attr-name: #D19A66;
153
- --docuserve-tok-attr-value: #98C379;
154
-
155
- --docuserve-table-header-bg: #26211C;
156
- --docuserve-table-row-alt-bg: #1F1B17;
157
- --docuserve-blockquote-bg: #1F1B17;
158
- --docuserve-blockquote-border: #5DB8A8;
159
- --docuserve-blockquote-text: #C9C0B3;
160
- --docuserve-mermaid-bg: #E8E0D4;
161
-
162
- --docuserve-scrollbar-track: #1B1814;
163
- --docuserve-scrollbar-thumb: #3A322B;
164
- --docuserve-scrollbar-thumb-hover: #524438;
165
- }
166
- }
167
-
168
- :root[data-theme="dark"]
169
- {
170
- --docuserve-bg: #15120F;
171
- --docuserve-bg-elevated: #1B1814;
172
- --docuserve-border: #2F2823;
173
- --docuserve-border-soft: #26211C;
174
-
175
- --docuserve-text: #E8E0D4;
176
- --docuserve-text-strong: #F2ECE0;
177
- --docuserve-text-muted: #B5AA9A;
178
- --docuserve-text-dim: #7A6F62;
179
-
180
- --docuserve-accent: #5DB8A8;
181
- --docuserve-accent-hover: #7FCCB8;
182
-
183
- --docuserve-topbar-bg: #1A1612;
184
- --docuserve-topbar-text: #E8E0D4;
185
- --docuserve-topbar-text-muted: #B5AA9A;
186
- --docuserve-topbar-text-dim: #7A6F62;
187
- --docuserve-topbar-hover-bg: #2A241E;
188
- --docuserve-topbar-version-bg: rgba(255, 255, 255, 0.05);
189
- --docuserve-topbar-version-border: rgba(255, 255, 255, 0.09);
190
- --docuserve-topbar-version-text: #B5AA9A;
191
-
192
- --docuserve-sidebar-bg: #1B1814;
193
- --docuserve-sidebar-border: #2F2823;
194
- --docuserve-sidebar-border-soft: #26211C;
195
- --docuserve-sidebar-text: #C9C0B3;
196
- --docuserve-sidebar-group-title: #F2ECE0;
197
- --docuserve-sidebar-module-text: #B5AA9A;
198
- --docuserve-sidebar-hover-bg: #2A241E;
199
- --docuserve-sidebar-hover-text: #7FCCB8;
200
- --docuserve-sidebar-active-bg: #2F2823;
201
- --docuserve-sidebar-active-text: #7FCCB8;
202
- --docuserve-sidebar-search-bg: #26211C;
203
- --docuserve-sidebar-search-border: #2F2823;
204
-
205
- --docuserve-inline-code-bg: #2A241E;
206
- --docuserve-inline-code-text: #E8B07A;
207
-
208
- --docuserve-code-bg: #1E1A17;
209
- --docuserve-code-border: #2F2823;
210
- --docuserve-code-gutter-bg: #17130F;
211
- --docuserve-code-gutter-border: #2F2823;
212
- --docuserve-code-gutter-text: #6A6052;
213
- --docuserve-code-text: #E8E0D4;
214
-
215
- --docuserve-tok-keyword: #C678DD;
216
- --docuserve-tok-string: #98C379;
217
- --docuserve-tok-number: #D19A66;
218
- --docuserve-tok-comment: #7F848E;
219
- --docuserve-tok-operator: #56B6C2;
220
- --docuserve-tok-punctuation: #E8E0D4;
221
- --docuserve-tok-function: #61AFEF;
222
- --docuserve-tok-property: #E06C75;
223
- --docuserve-tok-tag: #E06C75;
224
- --docuserve-tok-attr-name: #D19A66;
225
- --docuserve-tok-attr-value: #98C379;
226
-
227
- --docuserve-table-header-bg: #26211C;
228
- --docuserve-table-row-alt-bg: #1F1B17;
229
- --docuserve-blockquote-bg: #1F1B17;
230
- --docuserve-blockquote-border: #5DB8A8;
231
- --docuserve-blockquote-text: #C9C0B3;
232
- --docuserve-mermaid-bg: #E8E0D4;
233
-
234
- --docuserve-scrollbar-track: #1B1814;
235
- --docuserve-scrollbar-thumb: #3A322B;
236
- --docuserve-scrollbar-thumb-hover: #524438;
237
- }
238
-
239
- /* ----------------------------------------------------------------------------
240
- Reset and base
241
- ---------------------------------------------------------------------------- */
242
-
243
- *, *::before, *::after
244
- {
245
- box-sizing: border-box;
246
- }
247
-
248
- html, body
249
- {
250
- margin: 0;
251
- padding: 0;
252
- font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif;
253
- font-size: 16px;
254
- line-height: 1.5;
255
- color: var(--docuserve-text);
256
- background-color: var(--docuserve-bg);
257
- -webkit-font-smoothing: antialiased;
258
- -moz-osx-font-smoothing: grayscale;
259
- transition: background-color 0.15s ease, color 0.15s ease;
260
- }
261
-
262
- /* Typography */
263
- h1, h2, h3, h4, h5, h6
264
- {
265
- margin-top: 0;
266
- line-height: 1.3;
267
- color: var(--docuserve-text-strong);
268
- }
269
-
270
- a
271
- {
272
- color: var(--docuserve-accent);
273
- text-decoration: none;
274
- }
275
-
276
- a:hover
277
- {
278
- color: var(--docuserve-accent-hover);
279
- }
280
-
281
- /* Application container */
282
- #Docuserve-Application-Container
283
- {
284
- min-height: 100vh;
285
- }
286
-
287
- /* Utility: scrollbar styling */
288
- ::-webkit-scrollbar
289
- {
290
- width: 8px;
291
- height: 8px;
292
- }
293
-
294
- ::-webkit-scrollbar-track
295
- {
296
- background: var(--docuserve-scrollbar-track);
297
- }
298
-
299
- ::-webkit-scrollbar-thumb
300
- {
301
- background: var(--docuserve-scrollbar-thumb);
302
- border-radius: 4px;
303
- }
304
-
305
- ::-webkit-scrollbar-thumb:hover
306
- {
307
- background: var(--docuserve-scrollbar-thumb-hover);
308
- }
309
-
310
- /* Responsive adjustments */
311
- @media (max-width: 768px)
312
- {
313
- html
314
- {
315
- font-size: 14px;
316
- }
317
-
318
- #Docuserve-Sidebar-Container
319
- {
320
- display: none;
321
- }
322
-
323
- .docuserve-body
324
- {
325
- flex-direction: column;
326
- }
327
- }