This repository has been archived on 2023-01-26. You can view files and clone it, but cannot push or open issues or pull requests.
automate/packages/docs
Ali BARIN d4ad8645c9 chore(docs): make baseUrl configurable
Use BASE_URL environment variable to configure baseUrl in docusaurus config. Otherwise, `/` is used by default.
2022-04-12 00:30:26 +03:00
..
docs docs: Fix key concepts sub-headings 2022-02-05 17:18:51 +03:00
src chore: Adjust primary color of docs and footer links 2022-02-03 11:53:53 +03:00
static feat: Add docs package which uses docusaurus internally 2021-12-09 17:52:21 +01:00
.gitignore feat: Add docs package which uses docusaurus internally 2021-12-09 17:52:21 +01:00
babel.config.js feat: Add docs package which uses docusaurus internally 2021-12-09 17:52:21 +01:00
docusaurus.config.js chore(docs): make baseUrl configurable 2022-04-12 00:30:26 +03:00
package.json chore: add eslint separately per package 2022-01-20 17:07:14 +01:00
README.md feat: Add docs package which uses docusaurus internally 2021-12-09 17:52:21 +01:00
sidebars.js feat: Add docs package which uses docusaurus internally 2021-12-09 17:52:21 +01: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.