trifid/docs
core a21c4bff08
/ build_x64 (push) Successful in 2m26s Details
/ build_arm64 (push) Successful in 10m4s Details
docusaurus init
2023-10-06 23:40:03 -04:00
..
blog docusaurus init 2023-10-06 23:40:03 -04:00
docs docusaurus init 2023-10-06 23:40:03 -04:00
src docusaurus init 2023-10-06 23:40:03 -04:00
static docusaurus init 2023-10-06 23:40:03 -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 docusaurus init 2023-10-06 23:40:03 -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.