Documentation for Jackal's blockchain Canine

docs how-to

Go to file

Patrick Dunlop cdd624e5f0 Fixing grammar and typos before Marty does		2022-09-17 10:43:47 -04:00
docs	Fixing grammar and typos before Marty does	2022-09-17 10:43:47 -04:00
src	fixed broken link	2022-09-14 17:08:34 -04:00
static	added images to docs	2022-09-14 11:53:31 -04:00
.gitignore	first commit	2022-07-09 11:52:30 -04: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.

$ yarn

$ 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.

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

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.