Skip to content
This repository has been archived by the owner on Aug 1, 2021. It is now read-only.

Latest commit

 

History

History
24 lines (15 loc) · 765 Bytes

README.md

File metadata and controls

24 lines (15 loc) · 765 Bytes

UNIHACK Event Guide

The UNIHACK Event Guide is built using MkDocs - a simple static site generator that reads files written in Markdown. We use ReadTheDocs to parse and host the booklet.

This guide is targeted for sponsors, recruiters, volunteers and other key people. This is not for competitors. If you are a competitor, please read the Competitors Handbook

Contribute

In order to contribute, we suggest having a local version of MkDocs. You will need Python 2.7 or Python 3.3+.

Install MkDocs through pip:

pip install mkdocs

In order to see the changes that you have made, use:

mkdocs serve

This should emulate the ReadTheDocs look in MkDocs.