vuenotes

create a notebook for the semester write markdown and let it render by vuepress

Getting Started

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites

You will need a current version of Python 3 and vuepress

Installing

After cloning the repository, you can fill out the needed informations for your upcoming semester in semester-data.json, you'll find a little example there already. Now run the following commands

# create your notebook
python create_notebook.py

# start a development server
vuepress dev

You might want to delete some files or week-folder while you are writing, just run the following command to update the table of contents

# create your notebook
python create_config.py

Built With

• Vuepress

Authors

• Tobias Klatt - Initial work - GitHub

See also the list of contributors who participated in this project.