/ciroh-ua_website

github.io documentation site for CIROH-UA.

Primary LanguageJavaScript

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" and click on Documentation.

  • Click on Edit page for adding new content.
  • Create a Pull Request.
  • Changes will be reviewed and Merged by admin.

Support Email: ciroh-it-admin@ua.edu

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

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