Skip to content

Commit 02f56c1

Browse files
authored
Merge pull request #24 from graphql-java-kickstart/feature/tooling-documentation
Add documentation page for embedded editors / tooling
2 parents 613779b + e3d2dff commit 02f56c1

File tree

1 file changed

+8
-9
lines changed
  • content/spring-boot/embedded-editors

1 file changed

+8
-9
lines changed

content/spring-boot/embedded-editors/index.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ The following GraphQL Embedded Editors are bundled for convenience:
3232

3333
## Altair
3434

35-
[Altair](https://github.com/imolorhe/altair) becomes accessible at the root /altair if the graphql.altair.enabled property is true.
35+
[Altair](https://github.com/imolorhe/altair) becomes accessible at the root `/altair` if the `graphql.altair.enabled` property is true.
3636

37-
Note that GraphQL server must be available at /graphql/\* context to be discovered by Altair.
37+
Note that GraphQL server must be available at `/graphql/\*` context to be discovered by Altair.
3838

3939
### Configuration Parameters
4040

41-
Available Spring Boot configuration parameters (either application.yml or application.properties):
41+
Available Spring Boot configuration parameters (either `application.yml` or `application.properties`):
4242

4343
```yaml
4444
altair:
@@ -69,13 +69,13 @@ altair:
6969
7070
## GraphQL Playground
7171
72-
[GraphQL Playground](https://github.com/prisma/graphql-playground) becomes accessible at root /playground (or as configured in graphql.playground.mapping) if the graphql.playground.enabled property is true.
72+
[GraphQL Playground](https://github.com/prisma/graphql-playground) becomes accessible at root `/playground` (or as configured in `graphql.playground.mapping`) if the `graphql.playground.enabled` property is true.
7373

7474
It uses an embedded GraphQL Playground React, in accordance to the official guide, using the 'minimum HTML' approach.
7575

7676
### Configuration Parameters
7777

78-
Available Spring Boot configuration parameters (either application.yml or application.properties):
78+
Available Spring Boot configuration parameters (either `application.yml` or `application.properties`):
7979

8080
```yaml
8181
graphql.playground:
@@ -125,8 +125,7 @@ Note that GraphQL server must be available at `/graphql/*` context to be discove
125125

126126
### Configuration Parameters
127127

128-
Available Spring Boot configuration parameters (either `application.yml`
129-
or `application.properties`):
128+
Available Spring Boot configuration parameters (either `application.yml` or `application.properties`):
130129

131130
```yaml
132131
graphiql:
@@ -167,9 +166,9 @@ the `graphiql.headers` group.
167166

168167
## GraphQL Voyager
169168

170-
[GraphQL Voyager](https://github.com/APIs-guru/graphql-voyager) becomes accessible at root /voyager (or as configured in voyager.mapping) if the graphql.voyager.enabled property is true.
169+
[GraphQL Voyager](https://github.com/APIs-guru/graphql-voyager) becomes accessible at root `/voyager` (or as configured in voyager.mapping) if the `graphql.voyager.enabled` property is true.
171170

172-
Available Spring Boot configuration parameters (either application.yml or application.properties):
171+
Available Spring Boot configuration parameters (either `application.yml` or `application.properties`):
173172

174173
### Configuration Parameters
175174

0 commit comments

Comments
 (0)