Skip to content

simonLeary42/ood-documentation

 
 

Repository files navigation

Website

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

Installation

$ yarn install or npm install

Local Development

$ yarn start or npm run start

This command starts the local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build or npm 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.

Continuous Integration

Some common defaults for linting/formatting have been set for you. If you integrate your project with an open source Continuous Integration system (e.g. Travis CI, CircleCI), you may check for issues using the following command.

$ yarn ci or npm ci

About

Documentation for Open OnDemand generated using Sphinx

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 38.3%
  • Batchfile 24.9%
  • Makefile 24.6%
  • HTML 4.0%
  • Ruby 3.0%
  • CSS 2.7%
  • Shell 2.5%