Skip to content

eXpOSNitc/expos-docs

Folders and files

NameName
Last commit message
Last commit date
Jun 12, 2021
Feb 9, 2024
Jul 12, 2021
Jul 18, 2021
Feb 9, 2024
Jun 12, 2021
Jul 12, 2021
Jul 22, 2021
Aug 5, 2022
Feb 9, 2024

Repository files navigation

eXpOS NIT-C Website

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/eXpOSNitc/expos-docs.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

If you encounter issues with the website or have fixes please raise a pull request/issue.