@threadlabs/looma 0.49.1 → 0.49.3
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/README.md +9 -4
- package/components/ui-cycle-button/ui-cycle-button.html +5 -3
- package/components/ui-cycle-button/ui-cycle-button.js +3 -2
- package/components/ui-search-result-row/ui-search-result-row.html +1 -1
- package/dist/index.js +1 -1
- package/docs/README.md +5 -3
- package/docs/catalog.json +2244 -31
- package/docs/catalog.mjs +2 -2
- package/docs/example-invocations.mjs +63 -0
- package/docs/framework-examples.d.mts +3 -1
- package/docs/framework-examples.mjs +158 -77
- package/docs/render.mjs +2 -2
- package/docs/site.mjs +3 -1
- package/package.json +2 -3
- package/styles/ui-search-result-row.css +1 -1
- package/vanilla/UiCycleButton.d.ts +2 -0
- package/vanilla/UiCycleButton.js +26 -21
package/docs/README.md
CHANGED
|
@@ -11,13 +11,13 @@ Looma ships the documentation generator and theme customizer used by its public
|
|
|
11
11
|
In a project with a `package.json`, install Looma and its documentation tools:
|
|
12
12
|
|
|
13
13
|
```sh
|
|
14
|
-
pnpm add
|
|
15
|
-
pnpm add -D
|
|
14
|
+
pnpm add @threadlabs/looma '@tiptap/core@>=2 <3' '@tiptap/pm@>=2 <3'
|
|
15
|
+
pnpm add -D markupress @threadlabs/markupkit vite
|
|
16
16
|
pnpm exec looma-docs init --title "The Fellowship"
|
|
17
17
|
pnpm exec looma-docs dev
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Use the tool versions accepted by Looma's optional peer dependencies.
|
|
20
|
+
Looma installs its HTML Next runtime automatically. Use the tool versions accepted by Looma's optional peer dependencies. Markupress renders authored documentation with Expressmark’s standard syntax and supplies section navigation with category overview links, a full-height sidebar, the shared Looma site header, mobile home-page navigation, and one appearance button that cycles Automatic, Light and Dark. The full built-in catalog includes document and compact editor examples; the commands above install their supported Tiptap 2 peers. Tiptap remains optional for applications and catalogs using only controls.
|
|
21
21
|
|
|
22
22
|
Initialization creates three project-owned files:
|
|
23
23
|
|
|
@@ -302,6 +302,8 @@ Discovery reads definitions and descriptions without executing their controllers
|
|
|
302
302
|
|
|
303
303
|
Author components and documentation examples in HTML Next. Vue, React and Svelte applications compile those definitions with the HTML Next Vite plugin or converter; framework conversion belongs in the consuming application. See the [loading guide](https://threadlabs.studio/looma/getting-started/) for framework setup, imports and styles.
|
|
304
304
|
|
|
305
|
+
The shared example generator parses HTML invocations into props, children and named slots, then prints each framework's public API. Catalog attributes carry the HTML Next parser's `valueType` node alongside the displayed `type`; the generator uses HTML Next's public value parser for booleans, numbers, collections and types selected by another prop. Svelte snippets use their slot's role as a name, with component names disambiguating repeated roles. React examples use slot objects and only the fragments required for multiple children. Vue named templates retain their position in the authored example. Structural indentation is rebuilt while inline spacing and preformatted text are preserved. The framework consumer tests compile and render representative generated examples through the actual adapters.
|
|
306
|
+
|
|
305
307
|
## Combine installed catalogs
|
|
306
308
|
|
|
307
309
|
A library can publish the versioned catalog shape exposed by `@threadlabs/looma/docs/catalog.json`. Add package exports or relative JSON files under `catalogs` in the configuration. Component identities are package-qualified; duplicate tags, conflicting categories and missing compound parents fail with ownership information instead of silently replacing a component.
|