Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 1.52 KB

README.md

File metadata and controls

64 lines (40 loc) · 1.52 KB

CIROH Documentation Site

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

How to Get Started?

Go to "https://ciroh-ua.github.io/" or "docs.ciroh.org"

  • Click on Documentation or any tab.
  • Click on Edit page at the bottom of the page for adding new content.
  • Create a Pull Request.
  • Changes will be reviewed and merged by admin.

Support Email: [email protected]

=========================================

Installation

  1. Download and Install node js LTS version from https://nodejs.org/en if not already installed.

  2. How to build and run this project locally.

npm install
npm run build
npm run start

Local Development

$ npm run 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

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

To deploy the website, we need to compile this project to deployable package.

$ npm run build

above command will create build directory in your project folder. We can now deploy the content of that directory to the web server.

Cheatsheet

Contributors