Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.01 KB

README.md

File metadata and controls

43 lines (27 loc) · 1.01 KB
Raw

Website

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

Initial SetUp

Get started by forking the project from Github.

Then open a terminal in your system

  • mkdir community-library
  • cd community-library
  • git clone https://github.com/<your github user name>/Community-Library.git

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

$ GIT_USER=<Your GitHub username> USE_SSH=true 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.