trifid/docs
core 3d24ee60cb
/ build (push) Successful in 1m55s Details
/ build_x64 (push) Successful in 2m24s Details
/ build_arm64 (push) Successful in 3m14s Details
[docs] dependency docs
2023-10-09 00:43:25 -04:00
..
blog docusaurus init 2023-10-06 23:40:03 -04:00
docs [docs] dependency docs 2023-10-09 00:43:25 -04:00
src update description & home hero button 2023-10-08 18:52:25 -04:00
static config reference 2023-10-08 00:54:52 -04:00
.gitignore docusaurus init 2023-10-06 23:40:03 -04:00
README.md docusaurus init 2023-10-06 23:40:03 -04:00
babel.config.js docusaurus init 2023-10-06 23:40:03 -04:00
docusaurus.config.js config reference 2023-10-08 00:54:52 -04:00
package.json docusaurus init 2023-10-06 23:40:03 -04:00
sidebars.js docusaurus init 2023-10-06 23:40:03 -04:00
yarn.lock docusaurus init 2023-10-06 23:40:03 -04:00

README.md

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

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> 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.