https://github.com/graphql-compose/graphql-compose.github.io
https://github.com/graphql-compose/graphql-compose.github.io
Last synced: 12 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/graphql-compose/graphql-compose.github.io
- Owner: graphql-compose
- Created: 2018-03-20T09:19:56.000Z (over 7 years ago)
- Default Branch: source
- Last Pushed: 2023-01-04T01:21:35.000Z (over 2 years ago)
- Last Synced: 2025-06-11T14:38:40.706Z (15 days ago)
- Language: TypeScript
- Homepage: https://graphql-compose.github.io
- Size: 5.23 MB
- Stars: 10
- Watchers: 1
- Forks: 10
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Graphql-compose website
**If you want to make changes in documentation, please do it in the upstream repo https://github.com/graphql-compose/graphql-compose/tree/master/docs. This repo contains configuration for docusaurus and styles for layout.**
**Use `source` branch for making PRs.** `.gihub.io` website requires that `master` branch is used only for already builded version. Changes from `source` branch are automatically picked into `master` branch by CI.
This code is used to generate https://graphql-compose.github.io. It pulls in files from `docs/` and `website/` to generate html files served on the site.
`website/` contains the JS, CSS, images and other files (and blog, which contains some markdown files too, these are separated from `docs/`, not too important).
`cd website && npm install && npm start` to start the development server & watcher.
Don't use `npm build`. It's mostly for debugging.
Two special files:
- `sidebars.json`: lists the sections.
- `siteConfig.json`: some header and i18n configs.
During your development, most changes will be picked up at each browser refresh. If you touch these two files or `blog/`, however, you'll have to restart the server to see the changes.
## Translations
The entire site can be translated via the [Crowdin project](https://crowdin.com/project/graphql-compose). This repo only has the canonical english documentation. Don't manually edit things in `i18n/`.
## Debugging
`console.log`s appear in your terminal!
## Building and Deploying
Changes from `source` branch are automatically picked into `master` branch by CI, then published. Translation download/uploads are still manual right now (needs API key, which @nodkz have).