Go to file
fryorcraken.eth 3aa9fcb601
add some docs and plugin to play around
2022-08-17 22:26:08 +10:00
docs add some docs and plugin to play around 2022-08-17 22:26:08 +10:00
src initial structure and testing 2022-08-17 22:26:08 +10:00
static initial structure and testing 2022-08-17 22:26:08 +10:00
.gitignore initial structure and testing 2022-08-17 22:26:08 +10:00
README.md initial structure and testing 2022-08-17 22:26:08 +10:00
babel.config.js initial structure and testing 2022-08-17 22:26:08 +10:00
docusaurus.config.js initial structure and testing 2022-08-17 22:26:08 +10:00
package-lock.json initial structure and testing 2022-08-17 22:26:08 +10:00
package.json initial structure and testing 2022-08-17 22:26:08 +10:00
sidebars.js Update sidebars.js 2022-08-17 22:26:08 +10:00
tsconfig.json initial structure and testing 2022-08-17 22:26:08 +10:00
yarn.lock initial structure and testing 2022-08-17 22:26:08 +10: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.