@kitr/kit-docs 0.6.0 → 0.7.0

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 (2) hide show
  1. package/README.md +1 -1
  2. package/package.json +42 -4
package/README.md CHANGED
@@ -6,6 +6,6 @@
6
6
  pnpm dlx @kitr/kitr new my-app --kit docs
7
7
  ```
8
8
 
9
- Read the guide at https://kitr.dev/docs/cli.
9
+ Read the guide at https://kitr.dev/kits/docs.
10
10
 
11
11
  Part of [kitr](https://kitr.dev), the TypeScript framework where everything is an add-on. MIT licensed.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kitr/kit-docs",
3
- "version": "0.6.0",
3
+ "version": "0.7.0",
4
4
  "description": "kitr new --kit docs: A static docs site from markdown: sidebar, search, package-manager commands, dark mode and llms.txt.",
5
5
  "kitr": {
6
6
  "name": "docs",
@@ -9,7 +9,45 @@
9
9
  "category": "kits",
10
10
  "runsOn": "both",
11
11
  "kind": "kit",
12
- "setup": "./kitr"
12
+ "setup": "./kitr",
13
+ "kit": {
14
+ "base": "app",
15
+ "audience": "Projects that need a docs site written in markdown, fast to load and easy for coding agents to read.",
16
+ "highlights": [
17
+ {
18
+ "title": "Write markdown, get pages",
19
+ "text": "Each file in `content/docs/` is a page, ordered by `nav.json`."
20
+ },
21
+ {
22
+ "title": "Search and dark mode",
23
+ "text": "Cmd+K searches every page, and the theme follows the system or the toggle."
24
+ },
25
+ {
26
+ "title": "Static and fast",
27
+ "text": "Every page is prerendered to HTML, with no server to run."
28
+ },
29
+ {
30
+ "title": "Agents can read it",
31
+ "text": "The build writes `llms.txt`, `llms-full.txt` and a `.md` copy of every page."
32
+ }
33
+ ],
34
+ "example": "examples/docs",
35
+ "entry": "content/docs/getting-started.md",
36
+ "run": [
37
+ [
38
+ "kitr dev",
39
+ "The docs site, reloading as you edit markdown"
40
+ ],
41
+ [
42
+ "kitr build",
43
+ "Every page as static HTML"
44
+ ],
45
+ [
46
+ "npm test",
47
+ "Vitest, rendering a page with its sidebar"
48
+ ]
49
+ ]
50
+ }
13
51
  },
14
52
  "type": "module",
15
53
  "license": "MIT",
@@ -18,7 +56,7 @@
18
56
  "url": "git+https://github.com/kitrjs/kitr.git",
19
57
  "directory": "packages/kit-docs"
20
58
  },
21
- "homepage": "https://kitr.dev/docs/cli",
59
+ "homepage": "https://kitr.dev/kits/docs",
22
60
  "bugs": "https://github.com/kitrjs/kitr/issues",
23
61
  "publishConfig": {
24
62
  "access": "public"
@@ -40,7 +78,7 @@
40
78
  "kitr-kit"
41
79
  ],
42
80
  "dependencies": {
43
- "@kitr/core": "0.6.0"
81
+ "@kitr/core": "0.7.0"
44
82
  },
45
83
  "devDependencies": {
46
84
  "tsdown": "^0.23.7",