ToolJet/docs
2022-01-11 09:03:48 +05:30
..
docs update docs for minio (#1772) 2022-01-10 08:57:37 +05:30
src [docs] improved intro page 2021-07-31 20:11:45 +05:30
static [docs] added meta image (#1785) 2022-01-11 09:03:48 +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] added meta image (#1785) 2022-01-11 09:03:48 +05:30
firebase.json Firebase config for documentation 2021-04-29 11:21:22 +05:30
package.json [docs] update docusaurus (#1427) 2021-11-18 20:48:54 +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 [docs] update docusaurus (#1427) 2021-11-18 20:48:54 +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.