Documentation for Jackal's blockchain Canine
Go to file
2023-01-05 18:51:51 -05:00
docs Update 2_installation.md 2023-01-05 18:51:51 -05:00
src updated index 2022-12-07 23:45:02 -05:00
static updated cname 2022-11-21 09:32:27 -05:00
.gitignore minor update 2022-12-02 10:46:59 -07:00
babel.config.js first commit 2022-07-09 11:52:30 -04:00
docusaurus.config.js updated config 2022-09-14 17:31:29 -04:00
package-lock.json first commit 2022-07-09 11:52:30 -04:00
package.json styling the docs 2022-09-02 11:26:48 -04:00
README.md first commit 2022-07-09 11:52:30 -04:00
sidebars.js first commit 2022-07-09 11:52:30 -04:00
yarn.lock styling the docs 2022-09-02 11:26:48 -04: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

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.