Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 1.44 KB

DEVELOPMENT.md

File metadata and controls

51 lines (36 loc) · 1.44 KB
Raw

The Subnomicon website is built using Docusaurus 3, a modern static website generator.

Development

Once you are prepared to merge your changes to the repo, please ensure you check out the CONTRIBUTION.md for proper procedures

Local Development

Install the required packages

yarn

Start a local development server

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.

If you are working with different languages you will need to either

a) Build the server and serve it with yarn build && yarn serve b) Run the dev server for each language with yarn start -- --locale en (Replace 'en' with the two letter code of whichever language you are working with)

Deploy (Staff Use Only)

This is only for preparing the documentation for deployment to GitHub Pages.

  1. Checkout to main branch.
git checkout main
  1. Ensure the build is working on a production build.
yarn build

This command generates static content into the build directory and will optimize any links, content, & documents.

  1. Deploy main to gh-pages branch with the below command.
GIT_USER=<Your GitHub username> yarn deploy