graphql-engine/docs
2022-06-15 12:44:17 +00:00
..
docs/graphql server/docs: remove references to distinct_on in MSSQL docs 2022-06-15 12:44:17 +00:00
public docs: move docs-new to docs 2022-04-13 12:01:50 +00:00
scripts docs: add cloud docs for billing owner 2022-04-18 14:56:19 +00:00
src docs: fix graphiql editor copying issue 2022-06-08 13:22:28 +00:00
static docs: update mssql read replica docs 2022-06-14 13:28:52 +00:00
wiki docs: move docs-new to docs 2022-04-13 12:01:50 +00:00
.gitignore docs: move docs-new to docs 2022-04-13 12:01:50 +00:00
babel.config.js docs: move docs-new to docs 2022-04-13 12:01:50 +00:00
CONTRIBUTING.md docs: move docs-new to docs 2022-04-13 12:01:50 +00:00
docusaurus.config.js docs: move docs-new to docs 2022-04-13 12:01:50 +00:00
package.json docs: move docs-new to docs 2022-04-13 12:01:50 +00:00
README.md docs: move docs-new to docs 2022-04-13 12:01:50 +00:00
sidebars.js docs: move docs-new to docs 2022-04-13 12:01:50 +00:00
sidebarsWiki.js docs: move docs-new to docs 2022-04-13 12:01:50 +00:00
tsconfig.json docs: move docs-new to docs 2022-04-13 12:01:50 +00:00
yarn.lock docs: move docs-new to docs 2022-04-13 12:01:50 +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.