erwinschrodinger1 / kuosc-website

Website of KUOSC. Build using docusaurus.io

KUOSC Website

URL: https://kuosc.org.np 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.

Contributing

You can contribute in this repository by forking it, creating a separate branch to do the task, making some changes, and creating pull request in this repository.

Warning: DONOT use npm or pnpm to install dependencies. Rather, just use yarn. Github actions will fail if you use anything other than yarn.