/expos-v2

OS Lab website v2

Primary LanguageHTML

eXpOS NITC Website

Build

A modern and feature rich version of eXpOS NITC built using mkDocs Material.

Setting Up

Using Docker

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

Using pipenv

# Clone the repository
$ git clone https://github.com/ghoshishan/expos-v2.git
# Install the packages
$ pipenv install
# Open a virtual env shell
$ pipenv shell

# exit shell
$ exit

Others

$ pip install -r requirements.txt

Running an instance

$ mkdocs serve

Your version of the website should be up in http://localhost:8000/.

Troubleshooting

Sometimes changes are not reflected on the website, make sure to disable caching in your browser.

CONTRIBUTING

Please port pages from https://exposnitc.github.io/ to Markdown and send a pull request.

The directory structure of the project is available here: https://github.com/eXpOSNitc/eXpOSNitc.github.io