create-graphql-markdown-docs 0.0.0-stage → 0.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.
@@ -0,0 +1,8 @@
1
+ import { fileURLToPath } from "node:url";
2
+
3
+ export default defineNuxtConfig({
4
+ extends: ['@graphql-markdown/nuxt-theme'],
5
+ // The layer's gqlmd-generate module watches generate-docs.ts itself, but
6
+ // has no way to know which schema file(s) it points at.
7
+ watch: [fileURLToPath(new URL("./schema/example.graphql", import.meta.url))],
8
+ });
@@ -0,0 +1,25 @@
1
+ {
2
+ "name": "graphql-markdown-docs",
3
+ "version": "0.1.0",
4
+ "private": true,
5
+ "description": "GraphQL API reference site powered by GraphQL Markdown",
6
+ "type": "module",
7
+ "scripts": {
8
+ "dev": "nuxi dev",
9
+ "generate": "nuxi generate",
10
+ "build": "nuxi build",
11
+ "preview": "nuxi preview"
12
+ },
13
+ "dependencies": {
14
+ "@graphql-markdown/nuxt-theme": "^0.1.0",
15
+ "@nuxt/content": "^3.16.0",
16
+ "@nuxt/ui": "^4.11.0",
17
+ "better-sqlite3": "^13.0.3",
18
+ "nuxt": "^4.5.2",
19
+ "tailwindcss": "^4.3.3"
20
+ },
21
+ "devDependencies": {},
22
+ "engines": {
23
+ "node": ">=22.12.0"
24
+ }
25
+ }
@@ -0,0 +1,55 @@
1
+ """
2
+ A simple example GraphQL schema demonstrating the GraphQL Markdown theme.
3
+ """
4
+ scalar DateTime
5
+
6
+ """
7
+ The root query type for the API.
8
+ """
9
+ type Query {
10
+ """
11
+ Retrieve a user by their ID.
12
+ """
13
+ user(id: ID!): User
14
+
15
+ """
16
+ List all available users.
17
+ """
18
+ users: [User!]!
19
+ }
20
+
21
+ """
22
+ A user in the system.
23
+ """
24
+ type User {
25
+ """
26
+ The unique identifier for this user.
27
+ """
28
+ id: ID!
29
+
30
+ """
31
+ The user's name.
32
+ """
33
+ name: String!
34
+
35
+ """
36
+ The user's email address.
37
+ """
38
+ email: String!
39
+
40
+ """
41
+ When this user account was created.
42
+ """
43
+ createdAt: DateTime!
44
+
45
+ """
46
+ The user's profile picture URL.
47
+ @deprecated Use `avatar` instead.
48
+ """
49
+ profilePictureUrl: String @deprecated(reason: "Use avatar field instead")
50
+
51
+ """
52
+ The user's avatar profile picture.
53
+ """
54
+ avatar: String
55
+ }