Skip to content

sCrypt-Inc/scryptTS-docs

Folders and files

NameName
Last commit message
Last commit date
May 21, 2024
Jun 18, 2024
Jul 3, 2024
Jun 24, 2024
May 15, 2024
May 21, 2024
Nov 22, 2022
May 20, 2024
Nov 22, 2022
Jun 24, 2024
May 23, 2024
Dec 1, 2022
May 16, 2024

Repository files navigation

Website

This documentation website is built using Docusaurus 2, a modern static website generator.

Installation

yarn

Local Development

Start a local development server and open a browser window. Most changes are reflected live without having to restart the server.

yarn start

Generate Open API docs

After updating the open-api/btc.yaml, this command need to be run to re-generate all docs in open-api/btc:

yarn gen-api-docs

Build

This command generates static content in the /build directory and can be served using a static content hosting service like S3 or GitHub Pages.

yarn build

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.