@thjodann/wk 1.0.3 → 1.0.4
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 +12 -13
- package/dist/core/config.d.ts +11 -0
- package/dist/core/config.js +47 -0
- package/dist/core/config.js.map +1 -1
- package/dist/core/site.d.ts +1 -1
- package/dist/core/site.js +514 -26
- package/dist/core/site.js.map +1 -1
- package/dist/core/theme.d.ts +1 -0
- package/dist/core/theme.js +304 -1
- package/dist/core/theme.js.map +1 -1
- package/docs/reference.md +19 -6
- package/docs/setup.md +6 -4
- package/package.json +1 -1
- package/skills/wk/SKILL.md +7 -5
package/skills/wk/SKILL.md
CHANGED
|
@@ -140,8 +140,9 @@ wiki. Make the first generated site feel native to the host project:
|
|
|
140
140
|
1. Run `wk setup --profile mixed --audience all --agent codex` in Codex-compatible IDEs so repo setup also installs the companion `/wk` skill.
|
|
141
141
|
2. Inspect README/docs/package metadata for product identity and durable facts.
|
|
142
142
|
3. Inspect actual visual sources before writing a theme: app/global CSS, design
|
|
143
|
-
tokens, theme files, landing page styles, app shell/layout styles,
|
|
144
|
-
|
|
143
|
+
tokens, theme files, landing page styles, app shell/layout styles, brand
|
|
144
|
+
image assets, favicon files, repo-local font files, and any existing brand
|
|
145
|
+
palette files.
|
|
145
146
|
4. Run `wk theme preview --json`. If the preview looks right, run
|
|
146
147
|
`wk theme init`; otherwise pass explicit `--project-name`, `--description`,
|
|
147
148
|
or `--mood`, then preview again.
|
|
@@ -149,8 +150,9 @@ wiki. Make the first generated site feel native to the host project:
|
|
|
149
150
|
architecture, distribution/support, important symbols, and a devlog event.
|
|
150
151
|
6. Run `wk validate`, `wk render`, and `wk site --audience all`.
|
|
151
152
|
7. Verify the generated site locally: Auto/Light/Dark controls, default theme,
|
|
152
|
-
|
|
153
|
-
text,
|
|
153
|
+
favicon, sidebar mark, home logo/wordmark, custom fonts, search, local
|
|
154
|
+
links/source-file links, and contrast for body text, muted text, accents,
|
|
155
|
+
badges, and tags.
|
|
154
156
|
|
|
155
157
|
Do not edit generated CSS in `wiki-site/`. The source of truth is
|
|
156
158
|
`.wikiwiki/site-theme.json` plus structured records.
|
|
@@ -260,4 +262,4 @@ steps and use the normal Wikiwiki flow.
|
|
|
260
262
|
|
|
261
263
|
## Site Theme Guidance
|
|
262
264
|
|
|
263
|
-
When asked to make the human wiki match a project, edit `.wikiwiki/site-theme.json` rather than generated CSS. Prefer `wk theme preview --json` and `wk theme init` first because they inspect CSS/design sources when present. If you hand-edit, use the host project's real visual language literally: default color mode, paired light/dark palettes, accent spectrum, neutral surfaces, sidebar/hero/card gradients, brand gradient, badge/tag colors, focus ring, gloss, shadows, border radius, code background, and font family. Then run `wk validate`, `wk render`, and `wk site`.
|
|
265
|
+
When asked to make the human wiki match a project, edit `.wikiwiki/site-theme.json` rather than generated CSS. Prefer `wk theme preview --json` and `wk theme init` first because they inspect CSS/design sources, brand image assets, favicon files, and repo-local font files when present. If you hand-edit, use the host project's real visual language literally: default color mode, paired light/dark palettes, accent spectrum, neutral surfaces, sidebar/hero/card gradients, brand gradient, logo/wordmark/favicon paths, badge/tag colors, focus ring, gloss, shadows, border radius, code background, font files, and font family. Then run `wk validate`, `wk render`, and `wk site`.
|