create-graphql-markdown-docs 1.1.4 → 1.2.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.
- package/README.md +14 -12
- package/lib/frameworks/index.mjs +4 -0
- package/lib/frameworks/markdown.mjs +1 -1
- package/lib/frameworks/presets.mjs +31 -0
- package/package.json +2 -2
- package/templates/docusaurus/README.md +1 -1
- package/templates/docusaurus/package.json +1 -1
- package/templates/docusaurus/static/img/graphql-markdown.svg +1 -204
- package/templates/markdown/README.md +1 -1
- package/templates/markdown/package.json +1 -1
- package/templates/nuxt/package.json +1 -1
package/README.md
CHANGED
|
@@ -66,9 +66,11 @@ With `--yes`, `--schema` and `--output` are required, and so is `--framework` wh
|
|
|
66
66
|
| Vocs | `docs/pages/api` | Router links; the suggested link root follows the route. |
|
|
67
67
|
| HonKit | `api` | Set `--site-base` if the site is served under a sub-path. |
|
|
68
68
|
| Hugo | `content/api` | Set `--site-base` if the site is served under a sub-path. |
|
|
69
|
+
| Docsify | `docs/api` | Router links; no `--site-base` needed, Docsify routes relative to `index.html`. |
|
|
69
70
|
| MkDocs | `docs/api` | Links relative to pages. |
|
|
70
71
|
| DocFX | `docs/api` | Links relative to pages. |
|
|
71
72
|
| mdBook | `src/api` | Links relative to pages. |
|
|
73
|
+
| Zola | `content/api` | Router links; no `--site-base`. Sub-paths: set `base_url` in config.toml. |
|
|
72
74
|
| Generic MDX | Any folder you choose | Framework-neutral `.mdx` pages (plain HTML, no components); links relative to pages. |
|
|
73
75
|
| Generic | Any folder you choose | Any Markdown/MDX site — you set the link root. |
|
|
74
76
|
|
|
@@ -101,17 +103,17 @@ npm create graphql-markdown-docs@latest -- --yes --dir ./my-docs --schema ./sche
|
|
|
101
103
|
|
|
102
104
|
#### Shared
|
|
103
105
|
|
|
104
|
-
| Flag | Description
|
|
105
|
-
| ---------------------------- |
|
|
106
|
-
| `[dir]`, `-d, --dir <path>` | Target folder (default: ask, or the current folder with `--existing`).
|
|
107
|
-
| `--new` \| `--existing` | Force scaffold or wire mode (default: picked from the folder).
|
|
108
|
-
| `--framework <name>` | Scaffold: `nuxt` \| `docusaurus` \| `markdown` \| `mdx` (default `nuxt`; `generic` is accepted as `markdown`). Wire: `docusaurus` \| `starlight` \| `fumadocs` \| `vocs` \| `honkit` \| `hugo` \| `mkdocs` \| `docfx` \| `mdbook` \| `nuxt` \| `mdx` \| `generic` (`markdown` is accepted as `generic`). |
|
|
109
|
-
| `--schema <source>` | Schema source: `<path\|url\|git:\|github:>`. See the table above.
|
|
110
|
-
| `--pm <name>` | Package manager: `npm` \| `pnpm` \| `yarn` \| `bun`. Otherwise detected from the invoking command, then from lockfiles.
|
|
111
|
-
| `--install` / `--no-install` | Install dependencies (or skip it). Wire mode installs nothing unless `--install` is passed.
|
|
112
|
-
| `-y, --yes` | Accept defaults and skip all prompts.
|
|
113
|
-
| `-h, --help` | Show usage and exit.
|
|
114
|
-
| `-v, --version` | Print the CLI version and exit.
|
|
106
|
+
| Flag | Description |
|
|
107
|
+
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
108
|
+
| `[dir]`, `-d, --dir <path>` | Target folder (default: ask, or the current folder with `--existing`). |
|
|
109
|
+
| `--new` \| `--existing` | Force scaffold or wire mode (default: picked from the folder). |
|
|
110
|
+
| `--framework <name>` | Scaffold: `nuxt` \| `docusaurus` \| `markdown` \| `mdx` (default `nuxt`; `generic` is accepted as `markdown`). Wire: `docusaurus` \| `starlight` \| `fumadocs` \| `vocs` \| `honkit` \| `hugo` \| `docsify` \| `mkdocs` \| `docfx` \| `mdbook` \| `zola` \| `nuxt` \| `mdx` \| `generic` (`markdown` is accepted as `generic`). |
|
|
111
|
+
| `--schema <source>` | Schema source: `<path\|url\|git:\|github:>`. See the table above. |
|
|
112
|
+
| `--pm <name>` | Package manager: `npm` \| `pnpm` \| `yarn` \| `bun`. Otherwise detected from the invoking command, then from lockfiles. |
|
|
113
|
+
| `--install` / `--no-install` | Install dependencies (or skip it). Wire mode installs nothing unless `--install` is passed. |
|
|
114
|
+
| `-y, --yes` | Accept defaults and skip all prompts. |
|
|
115
|
+
| `-h, --help` | Show usage and exit. |
|
|
116
|
+
| `-v, --version` | Print the CLI version and exit. |
|
|
115
117
|
|
|
116
118
|
#### Scaffold only
|
|
117
119
|
|
|
@@ -160,7 +162,7 @@ Then run `npm run doc` to generate the docs and `npm start` to serve them.
|
|
|
160
162
|
|
|
161
163
|
The scaffolder reports one anonymous event per run (scaffold or wire): the framework, mode and schema loader type, with custom strings, URLs and paths masked. No schema content is sent. Nothing is sent on `--dry-run`. The first run shows a notice.
|
|
162
164
|
|
|
163
|
-
Opt out with the `--no-telemetry` flag, `DO_NOT_TRACK=1`, or `gqlmd telemetry disable`. See [what is collected](https://graphql-markdown.dev/docs/telemetry).
|
|
165
|
+
Opt out with the `--no-telemetry` flag, `DO_NOT_TRACK=1`, or `gqlmd telemetry disable`. See [what is collected](https://graphql-markdown.dev/docs/reference/telemetry).
|
|
164
166
|
|
|
165
167
|
## Documentation
|
|
166
168
|
|
package/lib/frameworks/index.mjs
CHANGED
|
@@ -3,6 +3,7 @@ import { markdown, mdx } from "./markdown.mjs";
|
|
|
3
3
|
import { nuxt } from "./nuxt.mjs";
|
|
4
4
|
import {
|
|
5
5
|
docfx,
|
|
6
|
+
docsify,
|
|
6
7
|
fumadocs,
|
|
7
8
|
generic,
|
|
8
9
|
honkit,
|
|
@@ -11,6 +12,7 @@ import {
|
|
|
11
12
|
mkdocs,
|
|
12
13
|
starlight,
|
|
13
14
|
vocs,
|
|
15
|
+
zola,
|
|
14
16
|
} from "./presets.mjs";
|
|
15
17
|
|
|
16
18
|
/**
|
|
@@ -45,11 +47,13 @@ export const WIRE_FRAMEWORKS = {
|
|
|
45
47
|
vocs,
|
|
46
48
|
honkit,
|
|
47
49
|
hugo,
|
|
50
|
+
docsify,
|
|
48
51
|
mkdocs,
|
|
49
52
|
docfx,
|
|
50
53
|
mdbook,
|
|
51
54
|
nuxt,
|
|
52
55
|
mdx,
|
|
56
|
+
zola,
|
|
53
57
|
generic,
|
|
54
58
|
};
|
|
55
59
|
|
|
@@ -7,7 +7,7 @@ import { findIndentedLine } from "../rewrites/lines.mjs";
|
|
|
7
7
|
const MDX_FORMATTER = "@graphql-markdown/formatters/mdx";
|
|
8
8
|
// Kept in step with the @graphql-markdown/formatters workspace version by
|
|
9
9
|
// `packages/tooling-config/scripts/template-ranges.mts`.
|
|
10
|
-
const FORMATTERS_RANGE = "^1.
|
|
10
|
+
const FORMATTERS_RANGE = "^1.3.0";
|
|
11
11
|
|
|
12
12
|
/** Adds the mdx formatter to .graphqlrc, right before the `loaders:` line. */
|
|
13
13
|
export function writeMdxFormatter(tempDir) {
|
|
@@ -82,6 +82,22 @@ export const hugo = {
|
|
|
82
82
|
`Add a menu entry in your Hugo config pointing to \`${route}\`.`,
|
|
83
83
|
};
|
|
84
84
|
|
|
85
|
+
/** Docsify preset. */
|
|
86
|
+
export const docsify = {
|
|
87
|
+
id: "docsify",
|
|
88
|
+
name: "Docsify",
|
|
89
|
+
label: "Docsify",
|
|
90
|
+
formatter: "@graphql-markdown/formatters/docsify",
|
|
91
|
+
createCommand: "npx docsify-cli init <dir>",
|
|
92
|
+
detect: ["docsify-cli"],
|
|
93
|
+
links: "router",
|
|
94
|
+
contentRoot: "docs",
|
|
95
|
+
contentRoute: "/",
|
|
96
|
+
outputHint: "Docsify serves content from docs/",
|
|
97
|
+
nextSteps: () =>
|
|
98
|
+
'In docs/index.html set loadSidebar: true and alias: { "/.*/_sidebar.md": "/_sidebar.md" }, and load the Docsify v5 dist/ bundles (needed for callouts).',
|
|
99
|
+
};
|
|
100
|
+
|
|
85
101
|
/** MkDocs preset. */
|
|
86
102
|
export const mkdocs = {
|
|
87
103
|
id: "mkdocs",
|
|
@@ -123,6 +139,21 @@ export const mdbook = {
|
|
|
123
139
|
"List the generated pages in src/SUMMARY.md — mdBook only builds listed pages.",
|
|
124
140
|
};
|
|
125
141
|
|
|
142
|
+
/** Zola preset. */
|
|
143
|
+
export const zola = {
|
|
144
|
+
id: "zola",
|
|
145
|
+
name: "Zola",
|
|
146
|
+
label: "Zola",
|
|
147
|
+
formatter: "@graphql-markdown/formatters/zola",
|
|
148
|
+
createCommand: "zola init <dir>",
|
|
149
|
+
links: "router",
|
|
150
|
+
contentRoot: "content",
|
|
151
|
+
contentRoute: "/",
|
|
152
|
+
outputHint: "Zola reads content from content/",
|
|
153
|
+
nextSteps: ({ route }) =>
|
|
154
|
+
`Link \`${route}\` from your templates or menu; every section needs an _index.md (written by the preset).`,
|
|
155
|
+
};
|
|
156
|
+
|
|
126
157
|
/** Generic Markdown fallback (no formatter preset). */
|
|
127
158
|
export const generic = {
|
|
128
159
|
id: "generic",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-graphql-markdown-docs",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.2.0",
|
|
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",
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
],
|
|
48
48
|
"dependencies": {
|
|
49
49
|
"@clack/prompts": "^1.0.0",
|
|
50
|
-
"@graphql-markdown/telemetry": "^0.2.
|
|
50
|
+
"@graphql-markdown/telemetry": "^0.2.2",
|
|
51
51
|
"graphql": "^16.8.0 || ^17.0.0",
|
|
52
52
|
"package-manager-detector": "^1.8.0"
|
|
53
53
|
},
|
|
@@ -18,7 +18,7 @@ npm start
|
|
|
18
18
|
|
|
19
19
|
## Your GraphQL Schema
|
|
20
20
|
|
|
21
|
-
The schema is configured in `.graphqlrc` (see the [documentation](https://graphql-markdown.dev/docs/configuration#graphql-config)). By default it reads the bundled `schema/example.graphql`:
|
|
21
|
+
The schema is configured in `.graphqlrc` (see the [documentation](https://graphql-markdown.dev/docs/reference/configuration#graphql-config)). By default it reads the bundled `schema/example.graphql`:
|
|
22
22
|
|
|
23
23
|
```yaml
|
|
24
24
|
schema: './schema/example.graphql'
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
"dependencies": {
|
|
16
16
|
"@docusaurus/core": "^3.10.0",
|
|
17
17
|
"@docusaurus/preset-classic": "^3.10.0",
|
|
18
|
-
"@graphql-markdown/docusaurus": "^1.39.
|
|
18
|
+
"@graphql-markdown/docusaurus": "^1.39.4",
|
|
19
19
|
"@graphql-tools/graphql-file-loader": "^8.1.21 || ^9.0.6",
|
|
20
20
|
"@mdx-js/react": "^3.1.1",
|
|
21
21
|
"graphql": "^16.13.2 || ^17.0.0",
|
|
@@ -1,204 +1 @@
|
|
|
1
|
-
|
|
2
|
-
<svg
|
|
3
|
-
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
|
4
|
-
xmlns:cc="http://creativecommons.org/ns#"
|
|
5
|
-
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
|
6
|
-
xmlns:svg="http://www.w3.org/2000/svg"
|
|
7
|
-
xmlns="http://www.w3.org/2000/svg"
|
|
8
|
-
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
|
9
|
-
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
|
10
|
-
inkscape:export-ydpi="96"
|
|
11
|
-
inkscape:export-xdpi="96"
|
|
12
|
-
inkscape:export-filename="/Users/gregory.heitz/Downloads/graphql-markdown.png"
|
|
13
|
-
inkscape:version="1.0beta2 (2b71d25, 2019-12-03)"
|
|
14
|
-
sodipodi:docname="graphql-markdown.svg"
|
|
15
|
-
xml:space="preserve"
|
|
16
|
-
enable-background="new 0 0 400 400"
|
|
17
|
-
viewBox="0 0 400 400"
|
|
18
|
-
y="0px"
|
|
19
|
-
x="0px"
|
|
20
|
-
id="GraphQL_Logo"
|
|
21
|
-
version="1.1"><metadata
|
|
22
|
-
id="metadata1109"><rdf:RDF><cc:Work
|
|
23
|
-
rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
|
|
24
|
-
rdf:resource="http://purl.org/dc/dcmitype/StillImage" /><dc:title></dc:title></cc:Work></rdf:RDF></metadata><defs
|
|
25
|
-
id="defs1107" /><sodipodi:namedview
|
|
26
|
-
inkscape:current-layer="g1102"
|
|
27
|
-
inkscape:window-maximized="0"
|
|
28
|
-
inkscape:window-y="25"
|
|
29
|
-
inkscape:window-x="0"
|
|
30
|
-
inkscape:cy="42.149101"
|
|
31
|
-
inkscape:cx="123.08885"
|
|
32
|
-
inkscape:zoom="1.36"
|
|
33
|
-
showgrid="false"
|
|
34
|
-
id="namedview1105"
|
|
35
|
-
inkscape:window-height="1387"
|
|
36
|
-
inkscape:window-width="1720"
|
|
37
|
-
inkscape:pageshadow="2"
|
|
38
|
-
inkscape:pageopacity="0"
|
|
39
|
-
guidetolerance="10"
|
|
40
|
-
gridtolerance="10"
|
|
41
|
-
objecttolerance="10"
|
|
42
|
-
borderopacity="1"
|
|
43
|
-
inkscape:document-rotation="0"
|
|
44
|
-
bordercolor="#666666"
|
|
45
|
-
pagecolor="#ffffff" />
|
|
46
|
-
<g
|
|
47
|
-
id="g1102">
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
<g
|
|
64
|
-
style="fill:#374845;stroke:#374845"
|
|
65
|
-
id="g1734"><path
|
|
66
|
-
id="path1026"
|
|
67
|
-
d="M 126.91176,235.73529 V 104.50001 h 36.54412 L 200,152.74828 236.54411,104.50001 h 36.54412 l 0,167.63234 -35.44118,-2.57353 L 236.54411,160.468 200,208.71626 163.45588,160.468 v 75.26729 z"
|
|
68
|
-
inkscape:connector-curvature="0"
|
|
69
|
-
sodipodi:nodetypes="ccccccccccccc"
|
|
70
|
-
style="stroke-width:1.87787;fill:#374845;stroke:#374845" /><path
|
|
71
|
-
id="path1026-7"
|
|
72
|
-
d="m 257.13236,303.59948 -38.08824,-51.55537 c 76.17647,0 0,0 76.17647,0 z"
|
|
73
|
-
inkscape:connector-curvature="0"
|
|
74
|
-
sodipodi:nodetypes="cccc"
|
|
75
|
-
style="stroke-width:1.40836;fill:#374845;stroke:#374845" /></g><g
|
|
76
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
77
|
-
id="g1726"><g
|
|
78
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
79
|
-
id="g1052">
|
|
80
|
-
<g
|
|
81
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
82
|
-
id="g1050">
|
|
83
|
-
|
|
84
|
-
<rect
|
|
85
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
86
|
-
x="37.9"
|
|
87
|
-
y="312.2"
|
|
88
|
-
transform="matrix(-0.866 -0.5 0.5 -0.866 83.0693 663.3409)"
|
|
89
|
-
fill="#E535AB"
|
|
90
|
-
width="185"
|
|
91
|
-
height="16.6"
|
|
92
|
-
id="rect1048" />
|
|
93
|
-
</g>
|
|
94
|
-
</g><g
|
|
95
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
96
|
-
id="g1058">
|
|
97
|
-
<g
|
|
98
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
99
|
-
id="g1056">
|
|
100
|
-
|
|
101
|
-
<rect
|
|
102
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
103
|
-
x="177.1"
|
|
104
|
-
y="71.1"
|
|
105
|
-
transform="matrix(-0.866 -0.5 0.5 -0.866 463.3409 283.0693)"
|
|
106
|
-
fill="#E535AB"
|
|
107
|
-
width="185"
|
|
108
|
-
height="16.6"
|
|
109
|
-
id="rect1054" />
|
|
110
|
-
</g>
|
|
111
|
-
</g><g
|
|
112
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
113
|
-
id="g1064">
|
|
114
|
-
<g
|
|
115
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
116
|
-
id="g1062">
|
|
117
|
-
|
|
118
|
-
<rect
|
|
119
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
120
|
-
x="122.1"
|
|
121
|
-
y="-13"
|
|
122
|
-
transform="matrix(-0.5 -0.866 0.866 -0.5 126.7903 232.1221)"
|
|
123
|
-
fill="#E535AB"
|
|
124
|
-
width="16.6"
|
|
125
|
-
height="185"
|
|
126
|
-
id="rect1060" />
|
|
127
|
-
</g>
|
|
128
|
-
</g><g
|
|
129
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
130
|
-
id="g1076">
|
|
131
|
-
<g
|
|
132
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
133
|
-
id="g1074">
|
|
134
|
-
<rect
|
|
135
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
136
|
-
x="52.5"
|
|
137
|
-
y="107.5"
|
|
138
|
-
fill="#E535AB"
|
|
139
|
-
width="16.6"
|
|
140
|
-
height="185"
|
|
141
|
-
id="rect1072" />
|
|
142
|
-
</g>
|
|
143
|
-
</g><g
|
|
144
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
145
|
-
id="g1082">
|
|
146
|
-
<g
|
|
147
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
148
|
-
id="g1080">
|
|
149
|
-
<rect
|
|
150
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
151
|
-
x="330.9"
|
|
152
|
-
y="107.5"
|
|
153
|
-
fill="#E535AB"
|
|
154
|
-
width="16.6"
|
|
155
|
-
height="185"
|
|
156
|
-
id="rect1078" />
|
|
157
|
-
</g>
|
|
158
|
-
</g><g
|
|
159
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
160
|
-
id="g1088">
|
|
161
|
-
<g
|
|
162
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
163
|
-
id="g1086">
|
|
164
|
-
|
|
165
|
-
<rect
|
|
166
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
167
|
-
x="262.4"
|
|
168
|
-
y="240.1"
|
|
169
|
-
transform="matrix(-0.5 -0.866 0.866 -0.5 126.7953 714.2875)"
|
|
170
|
-
fill="#E535AB"
|
|
171
|
-
width="14.5"
|
|
172
|
-
height="160.9"
|
|
173
|
-
id="rect1084" />
|
|
174
|
-
</g>
|
|
175
|
-
</g><path
|
|
176
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
177
|
-
fill="#E535AB"
|
|
178
|
-
d="M369.5,297.9c-9.6,16.7-31,22.4-47.7,12.8c-16.7-9.6-22.4-31-12.8-47.7c9.6-16.7,31-22.4,47.7-12.8 C373.5,259.9,379.2,281.2,369.5,297.9"
|
|
179
|
-
id="path1090" /><path
|
|
180
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
181
|
-
fill="#E535AB"
|
|
182
|
-
d="M90.9,137c-9.6,16.7-31,22.4-47.7,12.8c-16.7-9.6-22.4-31-12.8-47.7c9.6-16.7,31-22.4,47.7-12.8 C94.8,99,100.5,120.3,90.9,137"
|
|
183
|
-
id="path1092" /><path
|
|
184
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
185
|
-
fill="#E535AB"
|
|
186
|
-
d="M30.5,297.9c-9.6-16.7-3.9-38,12.8-47.7c16.7-9.6,38-3.9,47.7,12.8c9.6,16.7,3.9,38-12.8,47.7 C61.4,320.3,40.1,314.6,30.5,297.9"
|
|
187
|
-
id="path1094" /><path
|
|
188
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
189
|
-
fill="#E535AB"
|
|
190
|
-
d="M309.1,137c-9.6-16.7-3.9-38,12.8-47.7c16.7-9.6,38-3.9,47.7,12.8c9.6,16.7,3.9,38-12.8,47.7 C340.1,159.4,318.7,153.7,309.1,137"
|
|
191
|
-
id="path1096" /><path
|
|
192
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
193
|
-
fill="#E535AB"
|
|
194
|
-
d="M200,395.8c-19.3,0-34.9-15.6-34.9-34.9c0-19.3,15.6-34.9,34.9-34.9c19.3,0,34.9,15.6,34.9,34.9 C234.9,380.1,219.3,395.8,200,395.8"
|
|
195
|
-
id="path1098" /><path
|
|
196
|
-
style="stroke:#87deaa;fill:#87deaa"
|
|
197
|
-
fill="#E535AB"
|
|
198
|
-
d="M200,74c-19.3,0-34.9-15.6-34.9-34.9c0-19.3,15.6-34.9,34.9-34.9c19.3,0,34.9,15.6,34.9,34.9 C234.9,58.4,219.3,74,200,74"
|
|
199
|
-
id="path1100" /></g><path
|
|
200
|
-
inkscape:connector-curvature="0"
|
|
201
|
-
id="path1730"
|
|
202
|
-
d="m 194.94107,395.2422 c -13.95633,-1.99842 -26.08609,-13.45037 -28.90983,-27.29432 -0.76471,-3.7492 -0.76539,-10.30665 -0.001,-14.0052 0.32479,-1.5724 0.45524,-2.99149 0.28988,-3.15353 -0.36564,-0.35832 -79.912818,-46.29934 -80.167583,-46.29934 -0.09914,0 -1.11264,0.79854 -2.252228,1.77454 -4.332239,3.71034 -9.402945,6.43791 -14.571982,7.83839 -4.381128,1.18701 -12.734297,1.19034 -17.095588,0.007 -12.172819,-3.30332 -21.259341,-12.15806 -24.856068,-24.22203 -1.363662,-4.57392 -1.611858,-11.36973 -0.594715,-16.28377 2.47393,-11.95211 11.321974,-22.08664 22.637015,-25.92839 l 3.184205,-1.08113 -0.09331,-46.62357 -0.09331,-46.62357 -2.692031,-0.90652 C 25.431016,144.26008 18.013932,113.80787 35.822744,95.366147 42.403226,88.551798 51.078061,84.947463 60.871975,84.958364 c 8.670761,0.0097 16.674107,3.120621 23.252188,9.038335 l 1.928658,1.735044 39.983109,-23.064427 c 21.99071,-12.685434 40.1184,-23.183801 40.28375,-23.329706 0.16536,-0.145904 0.0321,-1.565489 -0.29615,-3.154632 -0.75987,-3.678772 -0.77327,-10.499693 -0.0275,-14.024977 2.92621,-13.833188 13.81483,-24.5349388 27.60562,-27.1318651 4.36584,-0.8221239 11.25934,-0.5734198 15.43213,0.5567614 11.53708,3.1247611 21.19458,12.7081837 24.46221,24.2745587 1.1387,4.030657 1.39611,11.619125 0.54032,15.929081 -0.36572,1.841922 -0.5056,3.379628 -0.32345,3.556 0.1765,0.170908 17.85768,10.43218 39.29151,22.802823 21.43382,12.370644 39.42477,22.75878 39.97988,23.084743 0.99235,0.582713 1.03558,0.567706 2.57353,-0.893283 4.65525,-4.422269 10.37421,-7.389173 17.00541,-8.822125 3.45538,-0.74668 9.92397,-0.726346 13.60294,0.04277 13.7836,2.881544 24.35614,13.424345 27.17345,27.097005 0.7522,3.65052 0.7522,10.16724 0,13.81776 -2.48511,12.06048 -11.32083,22.03184 -23.01083,25.96836 l -2.69203,0.90652 -0.0933,46.64348 -0.0933,46.64347 2.11537,0.65531 c 8.96471,2.77714 16.73516,9.49292 20.88002,18.04603 2.38764,4.92698 3.14797,7.99778 3.37551,13.63286 0.14911,3.69269 0.0489,5.52663 -0.43177,7.89864 -2.07402,10.2357 -8.51451,19.06809 -17.50962,24.01242 -8.68587,4.77436 -19.19231,5.53884 -28.65581,2.08508 -4.54637,-1.65922 -8.42518,-4.12493 -12.49149,-7.94074 l -1.65441,-1.55248 -39.88971,23.05527 c -36.20603,20.92619 -39.88505,23.13758 -39.83926,23.94682 0.0277,0.49034 0.33655,2.2978 0.68624,4.01655 0.92697,4.5561 0.61523,11.50752 -0.7172,15.99265 -4.94337,16.64007 -21.31527,27.20275 -38.37686,24.75974 z m 71.38213,-81.00437 39.84721,-23.0037 -0.66758,-2.80202 c -3.28351,-13.78186 2.40473,-28.63562 13.97488,-36.49276 2.64145,-1.79377 7.5309,-4.16408 9.86853,-4.78407 l 1.5625,-0.4144 v -46.81487 -46.81488 l -1.10964,-0.22192 c -2.22757,-0.44552 -6.83211,-2.62368 -9.93783,-4.70106 -7.40189,-4.95105 -12.60534,-12.74618 -14.52232,-21.75547 -0.70335,-3.30554 -0.68263,-10.22081 0.0411,-13.72477 0.31586,-1.52917 0.52266,-2.82758 0.45956,-2.88536 -0.38786,-0.35513 -80.55566,-46.509212 -80.78466,-46.509212 -0.15526,0 -0.59745,0.351041 -0.98265,0.780088 -1.34618,1.499423 -4.95773,4.059019 -7.96388,5.644203 -7.67675,4.048055 -16.74682,5.096437 -25.08943,2.900011 -3.64832,-0.960526 -10.02499,-4.256765 -12.82369,-6.62885 -1.39126,-1.179187 -2.73182,-2.293228 -2.97901,-2.475639 -0.30475,-0.224886 -13.33838,7.101658 -40.48513,22.757742 -22.01963,12.699169 -40.170409,23.207397 -40.335063,23.351607 -0.164651,0.14422 -0.04057,1.62648 0.275735,3.2939 2.184592,11.51623 -1.392037,23.02701 -9.712875,31.25929 -4.302015,4.25623 -9.484959,7.23467 -15.723051,9.03544 -0.364533,0.10523 -0.459559,9.77563 -0.459559,46.76823 v 46.63558 l 2.11397,0.66172 c 5.538625,1.73372 10.22203,4.57735 14.369283,8.7246 4.645883,4.64588 7.44471,9.57596 9.146515,16.11139 1.153706,4.43057 1.28678,11.20543 0.302081,15.37939 -0.349209,1.48025 -0.577654,2.74233 -0.507651,2.80463 0.07,0.0623 18.211245,10.55222 40.313875,23.31094 l 40.1866,23.19769 3.19575,-2.59548 c 3.68657,-2.9941 9.10696,-5.80568 13.48987,-6.99726 4.34876,-1.18229 12.70682,-1.18161 17.09559,0.001 5.91406,1.59415 11.74962,4.86994 15.43291,8.66325 0.90538,0.93243 1.85195,1.61635 2.10348,1.51983 0.25152,-0.0965 18.38857,-10.52716 40.30454,-23.17919 z"
|
|
203
|
-
style="display:inline;fill:#87deaa;fill-opacity:1;stroke:#87deaa;stroke-width:0.368226;stop-color:#000000" /></g>
|
|
204
|
-
</svg>
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg" id="GraphQL_Logo" x="0" y="0" enable-background="new 0 0 400 400" version="1.1" viewBox="0 0 400 400" xml:space="preserve"><metadata id="metadata1109"/><g id="g1102"><g style="fill:#374845;stroke:#374845" id="g1734"><path id="path1026" d="M 126.91176,235.73529 V 104.50001 h 36.54412 L 200,152.74828 236.54411,104.50001 h 36.54412 l 0,167.63234 -35.44118,-2.57353 L 236.54411,160.468 200,208.71626 163.45588,160.468 v 75.26729 z" style="stroke-width:1.87787;fill:#374845;stroke:#374845"/><path id="path1026-7" d="m 257.13236,303.59948 -38.08824,-51.55537 c 76.17647,0 0,0 76.17647,0 z" style="stroke-width:1.40836;fill:#374845;stroke:#374845"/></g><g style="stroke:#87deaa;fill:#87deaa" id="g1726"><g style="stroke:#87deaa;fill:#87deaa" id="g1052"><g style="stroke:#87deaa;fill:#87deaa" id="g1050"><rect style="stroke:#87deaa;fill:#87deaa" id="rect1048" width="185" height="16.6" x="37.9" y="312.2" fill="#E535AB" transform="matrix(-0.866 -0.5 0.5 -0.866 83.0693 663.3409)"/></g></g><g style="stroke:#87deaa;fill:#87deaa" id="g1058"><g style="stroke:#87deaa;fill:#87deaa" id="g1056"><rect style="stroke:#87deaa;fill:#87deaa" id="rect1054" width="185" height="16.6" x="177.1" y="71.1" fill="#E535AB" transform="matrix(-0.866 -0.5 0.5 -0.866 463.3409 283.0693)"/></g></g><g style="stroke:#87deaa;fill:#87deaa" id="g1064"><g style="stroke:#87deaa;fill:#87deaa" id="g1062"><rect style="stroke:#87deaa;fill:#87deaa" id="rect1060" width="16.6" height="185" x="122.1" y="-13" fill="#E535AB" transform="matrix(-0.5 -0.866 0.866 -0.5 126.7903 232.1221)"/></g></g><g style="stroke:#87deaa;fill:#87deaa" id="g1076"><g style="stroke:#87deaa;fill:#87deaa" id="g1074"><rect style="stroke:#87deaa;fill:#87deaa" id="rect1072" width="16.6" height="185" x="52.5" y="107.5" fill="#E535AB"/></g></g><g style="stroke:#87deaa;fill:#87deaa" id="g1082"><g style="stroke:#87deaa;fill:#87deaa" id="g1080"><rect style="stroke:#87deaa;fill:#87deaa" id="rect1078" width="16.6" height="185" x="330.9" y="107.5" fill="#E535AB"/></g></g><g style="stroke:#87deaa;fill:#87deaa" id="g1088"><g style="stroke:#87deaa;fill:#87deaa" id="g1086"><rect style="stroke:#87deaa;fill:#87deaa" id="rect1084" width="14.5" height="160.9" x="262.4" y="240.1" fill="#E535AB" transform="matrix(-0.5 -0.866 0.866 -0.5 126.7953 714.2875)"/></g></g><path style="stroke:#87deaa;fill:#87deaa" id="path1090" fill="#E535AB" d="M369.5,297.9c-9.6,16.7-31,22.4-47.7,12.8c-16.7-9.6-22.4-31-12.8-47.7c9.6-16.7,31-22.4,47.7-12.8 C373.5,259.9,379.2,281.2,369.5,297.9"/><path style="stroke:#87deaa;fill:#87deaa" id="path1092" fill="#E535AB" d="M90.9,137c-9.6,16.7-31,22.4-47.7,12.8c-16.7-9.6-22.4-31-12.8-47.7c9.6-16.7,31-22.4,47.7-12.8 C94.8,99,100.5,120.3,90.9,137"/><path style="stroke:#87deaa;fill:#87deaa" id="path1094" fill="#E535AB" d="M30.5,297.9c-9.6-16.7-3.9-38,12.8-47.7c16.7-9.6,38-3.9,47.7,12.8c9.6,16.7,3.9,38-12.8,47.7 C61.4,320.3,40.1,314.6,30.5,297.9"/><path style="stroke:#87deaa;fill:#87deaa" id="path1096" fill="#E535AB" d="M309.1,137c-9.6-16.7-3.9-38,12.8-47.7c16.7-9.6,38-3.9,47.7,12.8c9.6,16.7,3.9,38-12.8,47.7 C340.1,159.4,318.7,153.7,309.1,137"/><path style="stroke:#87deaa;fill:#87deaa" id="path1098" fill="#E535AB" d="M200,395.8c-19.3,0-34.9-15.6-34.9-34.9c0-19.3,15.6-34.9,34.9-34.9c19.3,0,34.9,15.6,34.9,34.9 C234.9,380.1,219.3,395.8,200,395.8"/><path style="stroke:#87deaa;fill:#87deaa" id="path1100" fill="#E535AB" d="M200,74c-19.3,0-34.9-15.6-34.9-34.9c0-19.3,15.6-34.9,34.9-34.9c19.3,0,34.9,15.6,34.9,34.9 C234.9,58.4,219.3,74,200,74"/></g><path id="path1730" d="m 194.94107,395.2422 c -13.95633,-1.99842 -26.08609,-13.45037 -28.90983,-27.29432 -0.76471,-3.7492 -0.76539,-10.30665 -0.001,-14.0052 0.32479,-1.5724 0.45524,-2.99149 0.28988,-3.15353 -0.36564,-0.35832 -79.912818,-46.29934 -80.167583,-46.29934 -0.09914,0 -1.11264,0.79854 -2.252228,1.77454 -4.332239,3.71034 -9.402945,6.43791 -14.571982,7.83839 -4.381128,1.18701 -12.734297,1.19034 -17.095588,0.007 -12.172819,-3.30332 -21.259341,-12.15806 -24.856068,-24.22203 -1.363662,-4.57392 -1.611858,-11.36973 -0.594715,-16.28377 2.47393,-11.95211 11.321974,-22.08664 22.637015,-25.92839 l 3.184205,-1.08113 -0.09331,-46.62357 -0.09331,-46.62357 -2.692031,-0.90652 C 25.431016,144.26008 18.013932,113.80787 35.822744,95.366147 42.403226,88.551798 51.078061,84.947463 60.871975,84.958364 c 8.670761,0.0097 16.674107,3.120621 23.252188,9.038335 l 1.928658,1.735044 39.983109,-23.064427 c 21.99071,-12.685434 40.1184,-23.183801 40.28375,-23.329706 0.16536,-0.145904 0.0321,-1.565489 -0.29615,-3.154632 -0.75987,-3.678772 -0.77327,-10.499693 -0.0275,-14.024977 2.92621,-13.833188 13.81483,-24.5349388 27.60562,-27.1318651 4.36584,-0.8221239 11.25934,-0.5734198 15.43213,0.5567614 11.53708,3.1247611 21.19458,12.7081837 24.46221,24.2745587 1.1387,4.030657 1.39611,11.619125 0.54032,15.929081 -0.36572,1.841922 -0.5056,3.379628 -0.32345,3.556 0.1765,0.170908 17.85768,10.43218 39.29151,22.802823 21.43382,12.370644 39.42477,22.75878 39.97988,23.084743 0.99235,0.582713 1.03558,0.567706 2.57353,-0.893283 4.65525,-4.422269 10.37421,-7.389173 17.00541,-8.822125 3.45538,-0.74668 9.92397,-0.726346 13.60294,0.04277 13.7836,2.881544 24.35614,13.424345 27.17345,27.097005 0.7522,3.65052 0.7522,10.16724 0,13.81776 -2.48511,12.06048 -11.32083,22.03184 -23.01083,25.96836 l -2.69203,0.90652 -0.0933,46.64348 -0.0933,46.64347 2.11537,0.65531 c 8.96471,2.77714 16.73516,9.49292 20.88002,18.04603 2.38764,4.92698 3.14797,7.99778 3.37551,13.63286 0.14911,3.69269 0.0489,5.52663 -0.43177,7.89864 -2.07402,10.2357 -8.51451,19.06809 -17.50962,24.01242 -8.68587,4.77436 -19.19231,5.53884 -28.65581,2.08508 -4.54637,-1.65922 -8.42518,-4.12493 -12.49149,-7.94074 l -1.65441,-1.55248 -39.88971,23.05527 c -36.20603,20.92619 -39.88505,23.13758 -39.83926,23.94682 0.0277,0.49034 0.33655,2.2978 0.68624,4.01655 0.92697,4.5561 0.61523,11.50752 -0.7172,15.99265 -4.94337,16.64007 -21.31527,27.20275 -38.37686,24.75974 z m 71.38213,-81.00437 39.84721,-23.0037 -0.66758,-2.80202 c -3.28351,-13.78186 2.40473,-28.63562 13.97488,-36.49276 2.64145,-1.79377 7.5309,-4.16408 9.86853,-4.78407 l 1.5625,-0.4144 v -46.81487 -46.81488 l -1.10964,-0.22192 c -2.22757,-0.44552 -6.83211,-2.62368 -9.93783,-4.70106 -7.40189,-4.95105 -12.60534,-12.74618 -14.52232,-21.75547 -0.70335,-3.30554 -0.68263,-10.22081 0.0411,-13.72477 0.31586,-1.52917 0.52266,-2.82758 0.45956,-2.88536 -0.38786,-0.35513 -80.55566,-46.509212 -80.78466,-46.509212 -0.15526,0 -0.59745,0.351041 -0.98265,0.780088 -1.34618,1.499423 -4.95773,4.059019 -7.96388,5.644203 -7.67675,4.048055 -16.74682,5.096437 -25.08943,2.900011 -3.64832,-0.960526 -10.02499,-4.256765 -12.82369,-6.62885 -1.39126,-1.179187 -2.73182,-2.293228 -2.97901,-2.475639 -0.30475,-0.224886 -13.33838,7.101658 -40.48513,22.757742 -22.01963,12.699169 -40.170409,23.207397 -40.335063,23.351607 -0.164651,0.14422 -0.04057,1.62648 0.275735,3.2939 2.184592,11.51623 -1.392037,23.02701 -9.712875,31.25929 -4.302015,4.25623 -9.484959,7.23467 -15.723051,9.03544 -0.364533,0.10523 -0.459559,9.77563 -0.459559,46.76823 v 46.63558 l 2.11397,0.66172 c 5.538625,1.73372 10.22203,4.57735 14.369283,8.7246 4.645883,4.64588 7.44471,9.57596 9.146515,16.11139 1.153706,4.43057 1.28678,11.20543 0.302081,15.37939 -0.349209,1.48025 -0.577654,2.74233 -0.507651,2.80463 0.07,0.0623 18.211245,10.55222 40.313875,23.31094 l 40.1866,23.19769 3.19575,-2.59548 c 3.68657,-2.9941 9.10696,-5.80568 13.48987,-6.99726 4.34876,-1.18229 12.70682,-1.18161 17.09559,0.001 5.91406,1.59415 11.74962,4.86994 15.43291,8.66325 0.90538,0.93243 1.85195,1.61635 2.10348,1.51983 0.25152,-0.0965 18.38857,-10.52716 40.30454,-23.17919 z" style="display:inline;fill:#87deaa;fill-opacity:1;stroke:#87deaa;stroke-width:.368226;stop-color:#000"/></g></svg>
|
|
@@ -10,4 +10,4 @@ npm run doc
|
|
|
10
10
|
|
|
11
11
|
### Your GraphQL Schema
|
|
12
12
|
|
|
13
|
-
The schema is configured in `.graphqlrc` (see the [documentation](https://graphql-markdown.dev/docs/configuration#graphql-config)). By default it reads the bundled `schema/example.graphql`. To change it, edit `schema` in `.graphqlrc` (a local file, or a URL, `git:` or `github:` reference) and declare the matching [graphql-tools loader](https://github.com/ardatan/graphql-tools/tree/master/packages/loaders) under `loaders`. Then run `npm run doc` again.
|
|
13
|
+
The schema is configured in `.graphqlrc` (see the [documentation](https://graphql-markdown.dev/docs/reference/configuration#graphql-config)). By default it reads the bundled `schema/example.graphql`. To change it, edit `schema` in `.graphqlrc` (a local file, or a URL, `git:` or `github:` reference) and declare the matching [graphql-tools loader](https://github.com/ardatan/graphql-tools/tree/master/packages/loaders) under `loaders`. Then run `npm run doc` again.
|