Welcome to the UniNotes GitHub repository! UniNotes is a comprehensive resource for university students to access and learn from notes and materials, built with MkDocs.
This repository is the home for the source code of the UniNotes website. Anyone is welcome to contribute to the development of the site by submitting pull requests.
- Fork the repository to your own GitHub account.
- Clone the repository to your local machine.
- Install the dependencies by running
pip install -r requirements.txt. - Start the development server by running
mkdocs serve. (alternativelypython3 -m mkdocs serve)
We welcome contributions to UniNotes from anyone. If you have notes, summaries, or study guides that would be valuable to other students, we encourage you to submit a pull request.
Before submitting a pull request, please make sure to:
- Test your changes thoroughly.
- Follow the code style of the project.
- Write clear and concise commit messages.
- Submit only one change per pull request.
Thank you for considering contributing to UniNotes!