create-graphql-markdown-docs 1.1.0 → 1.1.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.
package/README.md
CHANGED
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
# create-graphql-markdown-docs
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/create-graphql-markdown-docs)
|
|
4
|
+
[](https://raw.githubusercontent.com/graphql-markdown/graphql-markdown/main/LICENSE)
|
|
5
|
+
|
|
6
|
+
Interactive CLI that either creates a new [GraphQL-Markdown](https://graphql-markdown.dev) project (a ready-to-run Nuxt or Docusaurus API reference site, or plain Markdown or MDX output) or adds GraphQL-Markdown to an existing documentation site. The Nuxt preset is built on the [`@graphql-markdown/nuxt-theme`](https://www.npmjs.com/package/@graphql-markdown/nuxt-theme) layer.
|
|
4
7
|
|
|
5
8
|
Full guide: [graphql-markdown.dev/docs/get-started](https://graphql-markdown.dev/docs/get-started).
|
|
6
9
|
|
|
@@ -8,7 +11,7 @@ Full guide: [graphql-markdown.dev/docs/get-started](https://graphql-markdown.dev
|
|
|
8
11
|
|
|
9
12
|
Run it in an empty or new folder to create a new site, or inside an existing project to add GraphQL-Markdown to it (see [Add to an existing site](#add-to-an-existing-site)):
|
|
10
13
|
|
|
11
|
-
```
|
|
14
|
+
```shell
|
|
12
15
|
npm create graphql-markdown-docs@latest
|
|
13
16
|
# or pass the project directory directly
|
|
14
17
|
npm create graphql-markdown-docs@latest my-docs
|
|
@@ -27,7 +30,7 @@ To create a new site, follow the interactive prompts to:
|
|
|
27
30
|
|
|
28
31
|
Run the same command inside a folder that already contains a project. The CLI detects it and adds GraphQL-Markdown to it (wire mode):
|
|
29
32
|
|
|
30
|
-
```
|
|
33
|
+
```shell
|
|
31
34
|
cd my-starlight-site
|
|
32
35
|
npm create graphql-markdown-docs@latest
|
|
33
36
|
```
|
|
@@ -46,7 +49,7 @@ It never edits your framework configuration files and never overwrites existing
|
|
|
46
49
|
|
|
47
50
|
For CI or scripting, pass the required options and skip the prompts:
|
|
48
51
|
|
|
49
|
-
```
|
|
52
|
+
```shell
|
|
50
53
|
npm create graphql-markdown-docs@latest . -- --yes --schema ./schema.graphql --output src/content/docs/api --install
|
|
51
54
|
```
|
|
52
55
|
|
|
@@ -90,7 +93,7 @@ A local SDL/JSON file is copied into the scaffolded project's `schema/` director
|
|
|
90
93
|
|
|
91
94
|
For CI/CD or scripting, use `--yes`:
|
|
92
95
|
|
|
93
|
-
```
|
|
96
|
+
```shell
|
|
94
97
|
npm create graphql-markdown-docs@latest -- --yes --dir ./my-docs --schema ./schema.graphql --no-install --no-git
|
|
95
98
|
```
|
|
96
99
|
|
|
@@ -132,7 +135,9 @@ npm create graphql-markdown-docs@latest -- --yes --dir ./my-docs --schema ./sche
|
|
|
132
135
|
|
|
133
136
|
## What's included
|
|
134
137
|
|
|
135
|
-
|
|
138
|
+
### Nuxt
|
|
139
|
+
|
|
140
|
+
The default scaffold is a complete Nuxt 4 project:
|
|
136
141
|
|
|
137
142
|
- `nuxt.config.ts` — extends `@graphql-markdown/nuxt-theme`, nothing else required.
|
|
138
143
|
- `content.config.ts` — required in every consuming project (not inherited from the layer — see the theme's own README for why).
|
|
@@ -140,7 +145,7 @@ The scaffolded project is a real, complete Nuxt 4 project:
|
|
|
140
145
|
- `schema/` — your schema, or the bundled example.
|
|
141
146
|
- `app/app.config.ts` / `app/pages/index.vue` — a minimal landing page and theme override point, yours to edit.
|
|
142
147
|
|
|
143
|
-
|
|
148
|
+
### Docusaurus
|
|
144
149
|
|
|
145
150
|
With `--framework docusaurus`, the scaffold replaces the standalone `graphql-markdown/template` repo:
|
|
146
151
|
|
|
@@ -159,10 +164,12 @@ Opt out with the `--no-telemetry` flag, `DO_NOT_TRACK=1`, or `gqlmd telemetry di
|
|
|
159
164
|
|
|
160
165
|
## Documentation
|
|
161
166
|
|
|
162
|
-
- [`@graphql-markdown/nuxt-theme`](https://
|
|
167
|
+
- [`@graphql-markdown/nuxt-theme`](https://www.npmjs.com/package/@graphql-markdown/nuxt-theme) — the layer this scaffolds, including the full customization/swizzling reference.
|
|
163
168
|
- [GraphQL-Markdown documentation](https://graphql-markdown.dev)
|
|
164
169
|
- [Nuxt documentation](https://nuxt.com)
|
|
165
170
|
|
|
166
171
|
## License
|
|
167
172
|
|
|
168
|
-
MIT
|
|
173
|
+
GraphQL-Markdown packages are 100% free and open-source, under the [MIT license](https://github.com/graphql-markdown/graphql-markdown/blob/main/LICENSE).
|
|
174
|
+
|
|
175
|
+
This package is [Treeware](https://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/graphql-markdown/graphql-markdown) to thank us for our work. By contributing to the Treeware forest, you'll be creating employment for local families and restoring wildlife habitats.
|
|
@@ -6,7 +6,7 @@ import { findIndentedLine } from "../rewrites/lines.mjs";
|
|
|
6
6
|
|
|
7
7
|
const MDX_FORMATTER = "@graphql-markdown/formatters/mdx";
|
|
8
8
|
// Must match the @graphql-markdown/formatters release that ships `./mdx`.
|
|
9
|
-
const FORMATTERS_RANGE = "^1.2.
|
|
9
|
+
const FORMATTERS_RANGE = "^1.2.1";
|
|
10
10
|
|
|
11
11
|
/** Adds the mdx formatter to .graphqlrc, right before the `loaders:` line. */
|
|
12
12
|
export function writeMdxFormatter(tempDir) {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-graphql-markdown-docs",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.1",
|
|
4
4
|
"description": "Create a new GraphQL API documentation site with GraphQL Markdown and Nuxt or Docusaurus",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"homepage": "https://graphql-markdown.dev",
|
|
@@ -32,8 +32,8 @@
|
|
|
32
32
|
"build": "echo \"no build step — bin/, lib/ and templates/ ship as source\"",
|
|
33
33
|
"lint": "eslint --config ../../packages/tooling-config/eslint/config.ts \"bin/**/*.mjs\" \"lib/**/*.mjs\" \"tests/**/*.ts\"",
|
|
34
34
|
"lint:fix": "eslint --config ../../packages/tooling-config/eslint/config.ts \"bin/**/*.mjs\" \"lib/**/*.mjs\" \"tests/**/*.ts\" --fix",
|
|
35
|
-
"prettier": "prettier \"bin/**/*.mjs\" \"lib/**/*.mjs\" \"tests/**/*.ts\" --check",
|
|
36
|
-
"prettier:fix": "prettier \"bin/**/*.mjs\" \"lib/**/*.mjs\" \"tests/**/*.ts\" --write",
|
|
35
|
+
"prettier": "prettier \"bin/**/*.mjs\" \"lib/**/*.mjs\" \"tests/**/*.ts\" README.md --check",
|
|
36
|
+
"prettier:fix": "prettier \"bin/**/*.mjs\" \"lib/**/*.mjs\" \"tests/**/*.ts\" README.md --write",
|
|
37
37
|
"test": "vitest run --passWithNoTests",
|
|
38
38
|
"test:unit": "vitest run --passWithNoTests tests/unit",
|
|
39
39
|
"test:integration": "vitest run --passWithNoTests tests/integration",
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
],
|
|
48
48
|
"dependencies": {
|
|
49
49
|
"@clack/prompts": "^1.0.0",
|
|
50
|
-
"@graphql-markdown/telemetry": "^0.1.
|
|
50
|
+
"@graphql-markdown/telemetry": "^0.1.1",
|
|
51
51
|
"graphql": "^16.8.0 || ^17.0.0",
|
|
52
52
|
"package-manager-detector": "^1.8.0"
|
|
53
53
|
},
|
|
@@ -55,7 +55,7 @@
|
|
|
55
55
|
"@graphql-markdown/tooling-config": "^1.0.0"
|
|
56
56
|
},
|
|
57
57
|
"engines": {
|
|
58
|
-
"node": ">=22.
|
|
58
|
+
"node": ">=22.18.0"
|
|
59
59
|
},
|
|
60
60
|
"publishConfig": {
|
|
61
61
|
"access": "public"
|
|
@@ -15,11 +15,11 @@
|
|
|
15
15
|
"dependencies": {
|
|
16
16
|
"@docusaurus/core": "^3.10.0",
|
|
17
17
|
"@docusaurus/preset-classic": "^3.10.0",
|
|
18
|
-
"@graphql-markdown/docusaurus": "^1.39.
|
|
19
|
-
"@graphql-tools/graphql-file-loader": "^8.0.
|
|
18
|
+
"@graphql-markdown/docusaurus": "^1.39.1",
|
|
19
|
+
"@graphql-tools/graphql-file-loader": "^8.1.21 || ^9.0.6",
|
|
20
20
|
"@mdx-js/react": "^3.1.1",
|
|
21
|
-
"graphql": "^16.13.2",
|
|
22
|
-
"graphql-config": "^
|
|
21
|
+
"graphql": "^16.13.2 || ^17.0.0",
|
|
22
|
+
"graphql-config": "^6.0.0",
|
|
23
23
|
"prism-react-renderer": "^2.4.1",
|
|
24
24
|
"react": "^19.0.0",
|
|
25
25
|
"react-dom": "^19.0.0"
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
]
|
|
38
38
|
},
|
|
39
39
|
"engines": {
|
|
40
|
-
"node": ">=
|
|
40
|
+
"node": ">=22.18.0"
|
|
41
41
|
},
|
|
42
42
|
"overrides": {
|
|
43
43
|
"webpackbar": "^7.0.0"
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
"doc": "gqlmd graphql-to-doc"
|
|
6
6
|
},
|
|
7
7
|
"dependencies": {
|
|
8
|
-
"@graphql-markdown/cli": "^1.2.
|
|
9
|
-
"@graphql-tools/graphql-file-loader": "^8.0.
|
|
10
|
-
"graphql": "^16.13.2",
|
|
11
|
-
"graphql-config": "^
|
|
8
|
+
"@graphql-markdown/cli": "^1.2.1",
|
|
9
|
+
"@graphql-tools/graphql-file-loader": "^8.1.21 || ^9.0.6",
|
|
10
|
+
"graphql": "^16.13.2 || ^17.0.0",
|
|
11
|
+
"graphql-config": "^6.0.0"
|
|
12
12
|
}
|
|
13
13
|
}
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"preview": "nuxi preview"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@graphql-markdown/nuxt-theme": "^0.2.
|
|
14
|
+
"@graphql-markdown/nuxt-theme": "^0.2.1",
|
|
15
15
|
"@nuxt/content": "^3.16.0",
|
|
16
16
|
"@nuxt/ui": "^4.11.0",
|
|
17
17
|
"better-sqlite3": "^13.0.3",
|
|
@@ -20,6 +20,6 @@
|
|
|
20
20
|
},
|
|
21
21
|
"devDependencies": {},
|
|
22
22
|
"engines": {
|
|
23
|
-
"node": ">=22.
|
|
23
|
+
"node": ">=22.18.0"
|
|
24
24
|
}
|
|
25
25
|
}
|