https://github.com/scrypt-inc/scryptts-docs

https://github.com/scrypt-inc/scryptts-docs

scryptts

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/scrypt-inc/scryptts-docs
• Owner: sCrypt-Inc
• Created: 2022-11-22T09:26:22.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-03T18:37:22.000Z (9 months ago)
• Last Synced: 2024-04-04T12:17:12.965Z (9 months ago)
• Topics: scryptts
• Language: Shell
• Homepage: https://docs.scrypt.io
• Size: 187 MB
• Stars: 9
• Watchers: 3
• Forks: 6
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Website

This documentation website is built using [Docusaurus 2](https://docusaurus.io/), 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= 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.