@graphql-markdown/docusaurus 1.26.3 → 1.27.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 +2 -11
- package/dist/index.js +6 -4
- package/package.json +5 -4
package/README.md
CHANGED
|
@@ -12,20 +12,11 @@
|
|
|
12
12
|
|
|
13
13
|
## Installation
|
|
14
14
|
|
|
15
|
-
**`graphql` package is a peer-dependency, and it should be installed separately.**
|
|
16
|
-
|
|
17
15
|
```shell
|
|
18
|
-
npm
|
|
16
|
+
npm init docusaurus my-website https://github.com/graphql-markdown/template.git
|
|
19
17
|
```
|
|
20
18
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
```js
|
|
24
|
-
module.exports = {
|
|
25
|
-
// ...
|
|
26
|
-
plugins: ["@graphql-markdown/docusaurus"],
|
|
27
|
-
};
|
|
28
|
-
```
|
|
19
|
+
> _If you already have an existing Docusaurus installation, then see the [documentation](https://graphql-markdown.dev/docs/get-started) for alternative installation._
|
|
29
20
|
|
|
30
21
|
## Usage
|
|
31
22
|
|
package/dist/index.js
CHANGED
|
@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
6
|
exports.default = pluginGraphQLDocGenerator;
|
|
7
|
+
const utils_1 = require("@docusaurus/utils");
|
|
7
8
|
const core_1 = require("@graphql-markdown/core");
|
|
8
9
|
const logger_1 = __importDefault(require("@graphql-markdown/logger"));
|
|
9
10
|
const NAME = "docusaurus-graphql-doc-generator";
|
|
@@ -54,14 +55,15 @@ async function pluginGraphQLDocGenerator(_, options) {
|
|
|
54
55
|
.option("--skip <@directive...>", "Skip types with matching directive")
|
|
55
56
|
.option("--deprecated <option>", "Option for printing deprecated entities: `default`, `group` or `skip`")
|
|
56
57
|
.option("--pretty", "Prettify generated files")
|
|
57
|
-
// DEPRECATED options
|
|
58
|
-
.option("--noToc", "Disable page table of content [DEPRECATED]")
|
|
59
|
-
.option("--noPagination", "Disable page navigation buttons [DEPRECATED]")
|
|
60
|
-
.option("--noApiGroup", "Disable API grouping for types [DEPRECATED]")
|
|
61
58
|
.action(async (cliOptions) => {
|
|
62
59
|
const config = await (0, core_1.buildConfig)(options, cliOptions, options.id);
|
|
63
60
|
await (0, core_1.generateDocFromSchema)({
|
|
64
61
|
...config,
|
|
62
|
+
docOptions: {
|
|
63
|
+
...config.docOptions,
|
|
64
|
+
generatorFrameworkName: "docusaurus",
|
|
65
|
+
generatorFrameworkVersion: utils_1.DOCUSAURUS_VERSION,
|
|
66
|
+
},
|
|
65
67
|
loggerModule: LOGGER_MODULE,
|
|
66
68
|
});
|
|
67
69
|
});
|
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
"bugs": {
|
|
6
6
|
"url": "https://github.com/graphql-markdown/graphql-markdown/issues"
|
|
7
7
|
},
|
|
8
|
-
"version": "1.
|
|
8
|
+
"version": "1.27.0",
|
|
9
9
|
"license": "MIT",
|
|
10
10
|
"repository": {
|
|
11
11
|
"type": "git",
|
|
@@ -51,13 +51,14 @@
|
|
|
51
51
|
"docs": "typedoc"
|
|
52
52
|
},
|
|
53
53
|
"dependencies": {
|
|
54
|
-
"@
|
|
54
|
+
"@docusaurus/utils": ">=3.2.0",
|
|
55
|
+
"@graphql-markdown/core": "^1.13.0",
|
|
55
56
|
"@graphql-markdown/logger": "^1.0.5",
|
|
56
|
-
"@graphql-markdown/printer-legacy": "^1.
|
|
57
|
+
"@graphql-markdown/printer-legacy": "^1.10.0"
|
|
57
58
|
},
|
|
58
59
|
"devDependencies": {
|
|
59
60
|
"@docusaurus/types": "^3.5.0",
|
|
60
|
-
"@graphql-markdown/types": "^1.
|
|
61
|
+
"@graphql-markdown/types": "^1.5.0"
|
|
61
62
|
},
|
|
62
63
|
"peerDependencies": {
|
|
63
64
|
"@docusaurus/logger": "*"
|