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
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015 - 2026 Steven Velozo
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,5 +1,7 @@
1
1
  # pict-section-inlinedocumentation
2
2
 
3
+ > **[Read the Pict-Section-Inlinedocumentation Documentation](https://fable-retold.github.io/pict-section-inlinedocumentation/)** - interactive docs with the full API reference.
4
+
3
5
  > Embed context-aware documentation and tooltip help directly inside any Pict application.
4
6
 
5
7
  A Pict section that turns a folder of Markdown files into in-app help. Ships four progressively deeper embedding modes: a drop-in sidebar with a table of contents, route-mapped reading panes, hand-authored tooltips on specific controls, and auto-generated tooltips for every Manyfest-managed control in your app -- editable live when a content owner is signed in.
@@ -42,12 +44,8 @@ Add a container to your HTML and you're done:
42
44
 
43
45
  ## Four Levels of Embeddedness
44
46
 
45
- ```mermaid
46
- flowchart LR
47
- L1[1. Sidebar + ToC] --> L2[2. Route-Mapped]
48
- L2 --> L3[3. Hand-Authored Tooltips]
49
- L3 --> L4[4. Auto-Generated Tooltips]
50
- ```
47
+ <!-- bespoke diagram: edit diagrams/four-levels-of-embeddedness.mmd or .hints.json, then: npx pict-renderer-graph build modules/pict/pict-section-inlinedocumentation -->
48
+ ![Four Levels of Embeddedness](diagrams/four-levels-of-embeddedness.svg)
51
49
 
52
50
  | Level | What you get | Effort |
53
51
  |---|---|---|
@@ -77,14 +75,14 @@ Each level is a strict superset of the one below it.
77
75
 
78
76
  ## Documentation
79
77
 
80
- Full documentation lives in [`docs/`](./docs/) and is published via [pict-docuserve](https://github.com/stevenvelozo/pict-docuserve):
78
+ Full documentation lives in [`docs/`](./docs/) and is published via [pict-docuserve](https://github.com/fable-retold/pict-docuserve):
81
79
 
82
80
  - [Overview](./docs/overview.md)
83
81
  - [Quickstart](./docs/quickstart.md)
84
82
  - [Architecture](./docs/architecture.md)
85
83
  - [Implementation Reference](./docs/reference.md)
86
84
  - [API Reference](./docs/api-reference.md)
87
- - Embedding: [Level 1](./docs/embedding-level1-sidebar.md) · [Level 2](./docs/embedding-level2-routes.md) · [Level 3](./docs/embedding-level3-tooltips.md) · [Level 4](./docs/embedding-level4-autogen.md)
85
+ - Embedding: [Level 1](./docs/embedding-level1-sidebar.md) - [Level 2](./docs/embedding-level2-routes.md) - [Level 3](./docs/embedding-level3-tooltips.md) - [Level 4](./docs/embedding-level4-autogen.md)
88
86
 
89
87
  Regenerate the catalog and keyword index after editing any Markdown file:
90
88
 
@@ -96,11 +94,11 @@ npx quack prepare-docs
96
94
 
97
95
  | Module | Role |
98
96
  |---|---|
99
- | [pict](https://github.com/stevenvelozo/pict) | Application framework |
100
- | [pict-view](https://github.com/stevenvelozo/pict-view) | Base view class |
101
- | [pict-router](https://github.com/stevenvelozo/pict-router) | Route change source for Level 2 |
102
- | [pict-docuserve](https://github.com/stevenvelozo/pict-docuserve) | Catalog + keyword index producer |
103
- | [manyfest](https://github.com/stevenvelozo/manyfest) | Descriptors walked for Level 4 |
97
+ | [pict](https://github.com/fable-retold/pict) | Application framework |
98
+ | [pict-view](https://github.com/fable-retold/pict-view) | Base view class |
99
+ | [pict-router](https://github.com/fable-retold/pict-router) | Route change source for Level 2 |
100
+ | [pict-docuserve](https://github.com/fable-retold/pict-docuserve) | Catalog + keyword index producer |
101
+ | [manyfest](https://github.com/fable-retold/manyfest) | Descriptors walked for Level 4 |
104
102
 
105
103
  ## License
106
104