create-dox 0.1.0 → 0.3.1

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.
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env node
2
+ import {
3
+ migrateDocs
4
+ } from "../chunk-AFJGDIXU.js";
5
+ import "../chunk-673L75C2.js";
6
+ export {
7
+ migrateDocs
8
+ };
@@ -0,0 +1,7 @@
1
+ #!/usr/bin/env node
2
+ import {
3
+ scaffold
4
+ } from "./chunk-673L75C2.js";
5
+ export {
6
+ scaffold
7
+ };
package/package.json CHANGED
@@ -1,30 +1,37 @@
1
1
  {
2
2
  "name": "create-dox",
3
- "version": "0.1.0",
4
- "description": "Scaffold a new Dox documentation project.",
5
- "license": "MIT",
3
+ "version": "0.3.1",
4
+ "description": "Scaffold a new Dox documentation project",
6
5
  "type": "module",
6
+ "engines": {
7
+ "node": ">=18"
8
+ },
7
9
  "bin": {
8
10
  "create-dox": "./dist/index.js"
9
11
  },
12
+ "exports": {
13
+ ".": "./dist/index.js",
14
+ "./scaffold": "./dist/scaffold.js",
15
+ "./package.json": "./package.json"
16
+ },
10
17
  "files": [
11
18
  "dist"
12
19
  ],
13
20
  "scripts": {
14
- "build": "node build.mjs",
15
- "dev": "node src/index.js"
21
+ "build": "tsup",
22
+ "dev": "tsup --watch"
16
23
  },
17
- "dependencies": {},
18
- "engines": {
19
- "node": ">=18"
24
+ "dependencies": {
25
+ "@anthropic-ai/sdk": "^0.36.0",
26
+ "@inquirer/prompts": "^7.0.0",
27
+ "gray-matter": "^4.0.3",
28
+ "p-limit": "^6.1.0",
29
+ "tar": "^6.2.0"
20
30
  },
21
- "keywords": [
22
- "dox",
23
- "docs",
24
- "documentation",
25
- "cli",
26
- "scaffold",
27
- "template",
28
- "mintlify"
29
- ]
31
+ "devDependencies": {
32
+ "@types/node": "^22.0.0",
33
+ "@types/tar": "^6.1.13",
34
+ "tsup": "^8.0.0",
35
+ "typescript": "^5.0.0"
36
+ }
30
37
  }
package/README.md DELETED
@@ -1,79 +0,0 @@
1
- # create-dox
2
-
3
- Scaffold a new [Dox](https://github.com/kenny-io/Dox) documentation project in seconds.
4
-
5
- ## Usage
6
-
7
- ### With npx (recommended)
8
-
9
- ```bash
10
- npx create-dox my-docs
11
- ```
12
-
13
- ### Or install globally
14
-
15
- ```bash
16
- npm install -g create-dox
17
- create-dox my-docs
18
- ```
19
-
20
- ### Interactive prompts
21
-
22
- If you run without arguments, the CLI will ask you:
23
-
24
- ```
25
- $ npx create-dox
26
-
27
- ╔══════════════════════════════════════╗
28
- ║ ██████╗ ██████╗ ██╗ ██╗ ║
29
- ║ ██╔══██╗██╔═══██╗╚██╗██╔╝ ║
30
- ║ ██║ ██║██║ ██║ ╚███╔╝ ║
31
- ║ ██║ ██║██║ ██║ ██╔██╗ ║
32
- ║ ██████╔╝╚██████╔╝██╔╝ ██╗ ║
33
- ║ ╚═════╝ ╚═════╝ ╚═╝ ╚═╝ ║
34
- ║ ║
35
- ║ Beautiful docs, zero lock-in. ║
36
- ╚══════════════════════════════════════╝
37
-
38
- Project directory (my-docs): acme-docs
39
- Project name (Acme Docs):
40
- Description (Documentation for Acme Docs.):
41
- Brand preset:
42
- 1) primary
43
- 2) secondary
44
- > Choose [1]: 1
45
- GitHub repo URL (optional): https://github.com/acme/docs
46
- Install dependencies? (Y/n): Y
47
- ```
48
-
49
- ## What it does
50
-
51
- 1. Clones the Dox template from GitHub
52
- 2. Replaces example content with starter pages customized to your project name
53
- 3. Updates `src/data/site.ts` with your name, description, branding, and repo URL
54
- 4. Writes a minimal `docs.json` navigation config
55
- 5. Installs dependencies
56
- 6. Initializes a fresh git repo
57
-
58
- ## After scaffolding
59
-
60
- ```bash
61
- cd my-docs
62
- npm run dev
63
- ```
64
-
65
- Open [http://localhost:3040](http://localhost:3040) to see your docs.
66
-
67
- ### Key files
68
-
69
- | File | Purpose |
70
- | --- | --- |
71
- | `src/data/site.ts` | Site name, links, brand colors |
72
- | `docs.json` | Navigation tabs, groups, pages |
73
- | `src/content/*.mdx` | Your documentation pages |
74
- | `openapi.yaml` | API spec (optional) |
75
-
76
- ## Requirements
77
-
78
- - Node.js >= 18
79
- - Git