mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-14 17:02:49 +03:00

History

Rob Dominguez 0828f97dde Docs: Add admonition for including heading while testing PR-URL: https://github.com/hasura/graphql-engine-mono/pull/5591 GitOrigin-RevId: a260f5e1dc4d0d83e651a3a29f134d640715bd5d		2022-08-23 15:47:48 +00:00
..
docs	Docs: Add admonition for including heading while testing	2022-08-23 15:47:48 +00:00
public	docs: move docs-new to docs	2022-04-13 12:01:50 +00:00
scripts	docs: epic restructure	2022-07-20 16:36:00 +00:00
src	Docs: update EE references in Cloud+EE pages	2022-08-22 09:08:33 +00:00
static	docs: add runbook to wiki	2022-08-23 15:30:23 +00:00
wiki	docs: add runbook to wiki	2022-08-23 15:30:23 +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: epic restructure	2022-07-20 16:36:00 +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: epic restructure	2022-07-20 16:36:00 +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.

$ yarn

$ 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.

$ yarn build

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

$ 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.