Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #3174

Merged
merged 1 commit into from May 12, 2023
Merged

Update README.md #3174

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions packages/cm6-graphql/README.md
View file
Open in desktop
Expand Up @@ -5,7 +5,7 @@
[![License](https://img.shields.io/npm/l/cm6-graphql.svg?style=flat-square)](LICENSE)
[Discord Channel](https://discord.gg/cffZwk8NJW)

Provides CodeMirror 6 extension with a parser mode for GraphQL along with a
Provides CodeMirror 6 extension with a parser mode for GraphQL along with
autocomplete and linting powered by your GraphQL Schema.

### Getting Started
Expand All @@ -15,8 +15,8 @@ npm install --save cm6-graphql
```

[CodeMirror 6](https://codemirror.net/) customization is done through
[extensions](https://codemirror.net/docs/guide/#extension). This package an
extension that customizes codemirror 6 for GraphQL.
[extensions](https://codemirror.net/docs/guide/#extension). This package is
an extension that customizes CodeMirror 6 for GraphQL.

```js
import { basicSetup, EditorView } from 'codemirror';
Expand All @@ -31,16 +31,16 @@ const view = new EditorView({
});
```

Note: You have to provide a theme to CodeMirror 6 for the styling you want. You
_**Note:** You have to provide a theme to CodeMirror 6 for the styling you want. You
can take a look at
[this example](https://github.com/graphql/graphiql/blob/main/examples/cm6-graphql-parcel/src/index.ts)
or see the CodeMirror 6
[documentation examples](https://codemirror.net/examples/styling/) for more
details.
details._

### Updating schema

If you need to update the GraphQL schema used in the editor dynamically, you can
If you need to dynamically update the GraphQL schema used in the editor, you can
call `updateSchema` with the CodeMirror `EditorView` instance and the new schema

```js
Expand Down