Skip to content

Commit

Permalink
use headings for options in /plugins page instead of <details /> (#…
Browse files Browse the repository at this point in the history
…8787)

* fixes

* fix readme

* fix links

* add cache flag
  • Loading branch information
dimaMachina authored Jan 4, 2023
1 parent 3718463 commit 9dad0ac
Show file tree
Hide file tree
Showing 15 changed files with 561 additions and 538 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ recompile.sh
out
website/public/sitemap.xml
website/public/_redirects
.eslintcache
40 changes: 22 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,59 @@
[![CodeGen](./logo.svg)](https://graphql-code-generator.com)
[![CodeGen](./logo.svg)](https://the-guild.dev/graphql/codegen)

[![npm version](https://badge.fury.io/js/%40graphql-codegen%2Fcli.svg)](https://badge.fury.io/js/%40graphql-codegen%2Fcli)

[graphql-code-generator.com](https://graphql-code-generator.com)
[https://the-guild.dev/graphql/codegen](https://the-guild.dev/graphql/codegen)

GraphQL Code Generator is a tool that generates code out of your GraphQL schema. Whether you are developing a frontend or backend, you can utilize GraphQL Code Generator to generate output from your GraphQL Schema and GraphQL Documents (query/mutation/subscription/fragment).

By analyzing the schema and documents and parsing it, GraphQL Code Generator can output code at a wide variety of formats, based on pre-defined templates or based on custom user-defined ones. Regardless of the language that you're using, GraphQL Code Generator got you covered.

GraphQL Code Generator lets you choose the output that you need, based on _plugins_, which are very flexible and customizable. You can also write your _plugins_ to generate custom outputs that match your needs.

You can try this tool live on your browser and see some useful examples. Check out [GraphQL Code Generator Live Examples](https://graphql-code-generator.com/#live-demo).
You can try this tool live on your browser and see some useful examples. Check out [GraphQL Code Generator Live Examples](https://the-guild.dev/graphql/codegen/#live-demo).

We currently support and maintain [these plugins](https://graphql-code-generator.com/plugins) (TypeScript, Flow, React, Angular, MongoDB, Stencil, Reason, and some more), and there is an active community that writes and maintains custom plugins.
We currently support and maintain [these plugins](https://the-guild.dev/graphql/codegen/plugins) (TypeScript, Flow, React, Angular, MongoDB, Stencil, Reason, and some more), and there is an active community that writes and maintains custom plugins.

### Quick Start
## Quick Start

> You can find the complete instructions in [GraphQL-Code-Generator website](https://graphql-code-generator.com/docs/getting-started/installation).
> You can find the complete instructions in [GraphQL Code Generator website](https://the-guild.dev/graphql/codegen/docs/getting-started/installation).
Start by installing the basic deps of GraphQL Codegen;

yarn add graphql
yarn add -D @graphql-codegen/cli
```bash
yarn add graphql
yarn add -D @graphql-codegen/cli
```

GraphQL Code Generator lets you setup everything by simply running the following command:

yarn graphql-codegen init
```bash
yarn graphql-codegen init
```

Question by question, it will guide you through the whole process of setting up a schema, selecting plugins, picking a destination of a generated file, and a lot more.

If you wish to [manually setup codegen, follow these instructions](https://graphql-code-generator.com/docs/getting-started/installation).
If you wish to [manually setup codegen, follow these instructions](https://the-guild.dev/graphql/codegen/docs/getting-started/installation).

### Links
## Links

Besides our [docs page](https://graphql-code-generator.com/docs/getting-started), feel free to go through our published Medium articles to get a better grasp of what GraphQL Code Generator is all about:
Besides our [docs page](https://the-guild.dev/graphql/codegen/docs/getting-started), feel free to go through our published Medium articles to get a better grasp of what GraphQL Code Generator is all about:

- [All available plugins & presets](https://graphql-code-generator.com/plugins)
- [All available plugins & presets](https://the-guild.dev/graphql/codegen/plugins)

### Contributing
## Contributing

If this is your first time contributing to this project, please do read our [Contributor Workflow Guide](https://github.com/the-guild-org/Stack/blob/master/CONTRIBUTING.md) before you get started off.

Feel free to open issues and pull requests. We're always welcome support from the community.

For a contribution guide specific to this project, please refer to: http://graphql-code-generator.com/docs/custom-codegen/contributing
For a contribution guide specific to this project, please refer to: http://the-guild.dev/graphql/codegen/docs/custom-codegen/contributing

### Code of Conduct
## Code of Conduct

Help us keep GraphQL Codegenerator open and inclusive. Please read and follow our [Code of Conduct](https://github.com/the-guild-org/Stack/blob/master/CODE_OF_CONDUCT.md) as adopted from [Contributor Covenant](https://www.contributor-covenant.org/)
Help us keep GraphQL Code Generator open and inclusive. Please read and follow our [Code of Conduct](https://github.com/the-guild-org/Stack/blob/master/CODE_OF_CONDUCT.md) as adopted from [Contributor Covenant](https://contributor-covenant.org)

### License
## License

[![GitHub license](https://img.shields.io/badge/license-MIT-lightgrey.svg?maxAge=2592000)](https://raw.githubusercontent.com/apollostack/apollo-ios/master/LICENSE)

Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
"build": "bob build",
"watch-build": "npx tsc-watch --project tsconfig.json --onSuccess \"bob build\"",
"test": "jest --forceExit --no-watchman",
"lint": "eslint --ext .ts .",
"prettier": "prettier --write --list-different .",
"prettier:check": "prettier --check .",
"lint": "eslint --cache --ext .ts .",
"prettier": "prettier --cache --write --list-different .",
"prettier:check": "prettier --cache --check .",
"types:check": "tsc --noEmit",
"test-and-build": "yarn build && yarn test",
"ci:lint": "eslint --ext .ts . --output-file eslint_report.json --format json",
Expand Down
2 changes: 1 addition & 1 deletion packages/graphql-cli-codegen-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
<img src="https://github.com/dotansimha/graphql-code-generator/blob/master/logo.png?raw=true" />
</p>

Live demo and full documentation: [graphql-code-generator.com](https://graphql-code-generator.com)
Live demo and full documentation: [the-guild.dev/graphql/codegen](https://the-guild.dev/graphql/codegen)

Project repository: [graphql-code-generator](https://github.com/dotansimha/graphql-code-generator)
2 changes: 1 addition & 1 deletion packages/graphql-codegen-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
<img src="https://github.com/dotansimha/graphql-code-generator/blob/master/logo.png?raw=true" />
</p>

Live demo and full documentation: [graphql-code-generator.com](https://graphql-code-generator.com)
Live demo and full documentation: [the-guild.dev/graphql/codegen](https://the-guild.dev/graphql/codegen)

Project repository: [graphql-code-generator](https://github.com/dotansimha/graphql-code-generator)
2 changes: 1 addition & 1 deletion packages/graphql-codegen-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
<img src="https://github.com/dotansimha/graphql-code-generator/blob/master/logo.png?raw=true" />
</p>

Live demo and full documentation: [graphql-code-generator.com](https://graphql-code-generator.com)
Live demo and full documentation: [the-guild.dev/graphql/codegen](https://the-guild.dev/graphql/codegen)

Project repository: [graphql-code-generator](https://github.com/dotansimha/graphql-code-generator)
Loading

0 comments on commit 9dad0ac

Please sign in to comment.