create-dox 0.3.1 → 0.3.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/LICENSE +21 -0
- package/README.md +46 -0
- package/package.json +26 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Ekene Eze
|
|
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
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# create-dox
|
|
2
|
+
|
|
3
|
+
Scaffold a new [Dox](https://github.com/kenny-io/Dox) documentation project — an
|
|
4
|
+
agent-native docs site that serves every page to humans as polished HTML and to
|
|
5
|
+
AI agents as structured JSON, JSON-LD, and Markdown from the same URL.
|
|
6
|
+
|
|
7
|
+
## Quick start
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx create-dox my-docs
|
|
11
|
+
cd my-docs
|
|
12
|
+
npm run dev
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Then open [http://localhost:3040](http://localhost:3040). A freshly scaffolded
|
|
16
|
+
site is agent-ready out of the box and scores 100/A on the built-in
|
|
17
|
+
[Agent Readiness Score](https://github.com/kenny-io/Dox).
|
|
18
|
+
|
|
19
|
+
Run non-interactively with smart defaults:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npx create-dox my-docs --yes
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## What you get
|
|
26
|
+
|
|
27
|
+
- **MDX content** in `src/content/`, navigation in `docs.json`
|
|
28
|
+
- **Agent endpoints** — `/llms.txt`, `/ai.txt`, `/api/docs-index`, `/api/agent-readiness`
|
|
29
|
+
- **Hybrid search**, **retrieval-grounded AI chat**, and an **admin analytics** dashboard
|
|
30
|
+
- **Starter content** with keywords and structured pages, ready to edit
|
|
31
|
+
|
|
32
|
+
## Other commands
|
|
33
|
+
|
|
34
|
+
| Command | What it does |
|
|
35
|
+
| --- | --- |
|
|
36
|
+
| `create-dox <dir>` | Scaffold a new project |
|
|
37
|
+
| `create-dox migrate <github-url> [dir]` | Import docs from a GitHub repo (Mintlify, Docusaurus, GitBook, Nextra, …) |
|
|
38
|
+
| `create-dox check [dir] [--fix]` | Lint content for orphan pages and missing frontmatter |
|
|
39
|
+
| `create-dox translate --locale <code>` | Translate content into another locale |
|
|
40
|
+
|
|
41
|
+
Prefer a single binary? Install [`@doxlabs/cli`](https://www.npmjs.com/package/@doxlabs/cli)
|
|
42
|
+
and use `dox init`, which delegates here.
|
|
43
|
+
|
|
44
|
+
## License
|
|
45
|
+
|
|
46
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-dox",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.3",
|
|
4
4
|
"description": "Scaffold a new Dox documentation project",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"engines": {
|
|
@@ -15,7 +15,9 @@
|
|
|
15
15
|
"./package.json": "./package.json"
|
|
16
16
|
},
|
|
17
17
|
"files": [
|
|
18
|
-
"dist"
|
|
18
|
+
"dist",
|
|
19
|
+
"README.md",
|
|
20
|
+
"LICENSE"
|
|
19
21
|
],
|
|
20
22
|
"scripts": {
|
|
21
23
|
"build": "tsup",
|
|
@@ -33,5 +35,27 @@
|
|
|
33
35
|
"@types/tar": "^6.1.13",
|
|
34
36
|
"tsup": "^8.0.0",
|
|
35
37
|
"typescript": "^5.0.0"
|
|
38
|
+
},
|
|
39
|
+
"license": "MIT",
|
|
40
|
+
"keywords": [
|
|
41
|
+
"dox",
|
|
42
|
+
"documentation",
|
|
43
|
+
"docs",
|
|
44
|
+
"scaffold",
|
|
45
|
+
"mdx",
|
|
46
|
+
"nextjs",
|
|
47
|
+
"ai",
|
|
48
|
+
"agent-native",
|
|
49
|
+
"mcp",
|
|
50
|
+
"create"
|
|
51
|
+
],
|
|
52
|
+
"repository": {
|
|
53
|
+
"type": "git",
|
|
54
|
+
"url": "git+https://github.com/kenny-io/Dox.git",
|
|
55
|
+
"directory": "packages/create-dox"
|
|
56
|
+
},
|
|
57
|
+
"homepage": "https://github.com/kenny-io/Dox#readme",
|
|
58
|
+
"bugs": {
|
|
59
|
+
"url": "https://github.com/kenny-io/Dox/issues"
|
|
36
60
|
}
|
|
37
61
|
}
|