graphql-engine/docs-new
Tirumarai Selvan 8ef270404a support for graphql-ws is considered GA
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/4155
GitOrigin-RevId: 40033eb41849e88fc1b7a84a607ae9ce4abccf0b
2022-04-05 08:50:57 +00:00
..
docs/graphql support for graphql-ws is considered GA 2022-04-05 08:50:57 +00:00
public docs: migrate to docusaurus 2022-03-28 09:13:31 +00:00
scripts docs: migrate to docusaurus 2022-03-28 09:13:31 +00:00
src docs: Docusaurus after live changes/updates/fixes 2022-03-30 16:38:17 +00:00
static docs: migrate to docusaurus 2022-03-28 09:13:31 +00:00
wiki docs: Docusaurus after live changes/updates/fixes 2022-03-30 16:38:17 +00:00
.gitignore docs: migrate to docusaurus 2022-03-28 09:13:31 +00:00
babel.config.js docs: migrate to docusaurus 2022-03-28 09:13:31 +00:00
CONTRIBUTING.md docs: migrate to docusaurus 2022-03-28 09:13:31 +00:00
docusaurus.config.js docs: Docusaurus after live changes/updates/fixes 2022-03-30 16:38:17 +00:00
package.json docs: migrate to docusaurus 2022-03-28 09:13:31 +00:00
README.md docs: migrate to docusaurus 2022-03-28 09:13:31 +00:00
sidebars.js docs: Docusaurus after live changes/updates/fixes 2022-03-30 16:38:17 +00:00
sidebarsWiki.js docs: migrate to docusaurus 2022-03-28 09:13:31 +00:00
tsconfig.json docs: migrate to docusaurus 2022-03-28 09:13:31 +00:00
yarn.lock docs: migrate to docusaurus 2022-03-28 09:13:31 +00:00

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.