Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 877 Bytes

README.md

File metadata and controls

45 lines (28 loc) · 877 Bytes

Astria Docs

The Astria Docs website is built using Docusaurus 2.

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

The main astria docs website is deployed using the github deploy action.

To deploy manually:

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.