Skip to content
Snippets Groups Projects
Commit 9f3edd6d authored by Maciej Topyla's avatar Maciej Topyla
Browse files

Update README.md

parent 29f1e925
No related branches found
No related tags found
3 merge requests!34Draft: Configure and optimise mathjax for SVG and speed,!33Draft: Merging a new minimal version of the website from branch:enablingsearch,!26Fixing search function
Pipeline #121443 passed
# mathforquantum
Lecture notes and teaching material used for the Delft University of Technology course awesome course.
# Mathematics for Quantum Physics
Lecture notes and teaching material used for the Delft University of Technology course TN3105.
The compiled materials are available at https://mathforquantum.quantumtinkerer.tudelft.nl
......@@ -9,6 +8,10 @@ The compiled materials are available at https://mathforquantum.quantumtinkerer.t
This repository is based on a template for publishing lecture notes, developed
by Anton Akhmerov, who also hosts such repositories for other courses.
# Version
This a minimal stable version of the website from the branch "enabling search" based on mkdocs-material with a funcitoning website-wide search (without the support for inline jupyter notebook conversion by thebe)
# HOWTOs
## How to add new material to the lecture notes
......@@ -34,11 +37,11 @@ ending `.md`. In particular, in markdown you can
```
Other useful blocks are `!!! warning` and `!!! info`
3. Place figures in `src/figures`
3. Place figures in `docs/figures`
4. If you added a new markdown file that should be linked in the index, you need
to add it to `mkdocs.yml` under the `nav:` entry.
5. Whenever you push a commit to the branch/merge request, it will automatically be deployed on a preview webpage. This process may take a few minutes. You can find the preview website by going to your merge request. There will be on top a box with the label "Pipeline", and in the box a button "View app". Clicking on "View app" will bring you to the preview webpage.
6. When you are done with the merge request, remove "WIP:" from the title, and notify an instructor.
6. When you are done with the merge request, remove "Draft:" from the title, and notify an instructor.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment