ToolJet/docs
2021-06-08 22:01:55 +05:30
..
docs [Docs] Fixed broken link in k8s deployment guide (#205) 2021-06-08 22:01:55 +05:30
src [Docs] Table 2021-05-26 15:33:06 +05:30
static [Docs] Table 2021-05-26 15:33:06 +05:30
.gitignore Setup docusaurus 2021-04-23 21:19:14 +05:30
babel.config.js Setup docusaurus 2021-04-23 21:19:14 +05:30
docusaurus.config.js [Docs] Fixed broken navbar logo link 2021-06-02 23:24:46 +05:30
firebase.json Firebase config for documentation 2021-04-29 11:21:22 +05:30
package.json Setup docusaurus 2021-04-23 21:19:14 +05:30
README.md Setup docusaurus 2021-04-23 21:19:14 +05:30
sidebars.js Setup docusaurus 2021-04-23 21:19:14 +05:30
yarn.lock Setup docusaurus 2021-04-23 21:19:14 +05:30

Website

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

Installation

yarn install

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.