|
1 | 1 | # Virtual Anatomy Documentation |
2 | | -Documentation created using MkDocs. |
3 | | - |
4 | | -[Link](https://jrcz-data-science-lab.github.io/VirtualAnatomy-Documentation/) |
| 2 | +Documentation for the [Virtual Anatomy project](https://github.com/jrcz-data-science-lab/Virtual-Anatomy-UE) created on MkDocs. |
5 | 3 |
|
6 | 4 | ## Branches |
7 | 5 | - **`main`**: Contains the main content of the documentation. |
8 | 6 | - **`gh-pages`**: Auto-generated by a bot, contains the published documentation. |
9 | 7 |
|
10 | 8 | ## Installation |
11 | 9 |
|
12 | | -Ensure that you have `pip` and `python` installed. |
| 10 | +First of all, ensure that you have `pip` and `python` packages installed. |
13 | 11 |
|
14 | 12 | Then, run the following command to install MkDocs: |
15 | 13 |
|
16 | 14 | ```bash |
17 | 15 | pip install mkdocs |
18 | 16 | ``` |
19 | 17 |
|
20 | | -We use material theme and so should you ;), install it using following. |
| 18 | +The material theme is used within this documentation. For the best UI experience install it using the following command: |
21 | 19 |
|
22 | 20 | ```bash |
23 | 21 | pip install mkdocs-material |
24 | 22 | ``` |
25 | 23 |
|
26 | | -Afterward, serve the documentation locally by running: |
| 24 | +Afterward, you can serve the documentation locally by running: |
27 | 25 |
|
28 | 26 | ```bash |
29 | 27 | mkdocs serve |
30 | 28 | ``` |
31 | 29 |
|
32 | | -Make sure to execute this command in the root of the repository. |
| 30 | +**Make sure to execute this command in the root of the repository.** |
33 | 31 |
|
34 | 32 | ## Adding Pages |
35 | 33 |
|
36 | 34 | You should **always** add new `.md` files to the `docs` folder. You can create new folders and sub folders if necessary. |
37 | 35 |
|
38 | | -If your file is located inside the `docs` folder it will get automatically interpreted by the mk-docs framework |
| 36 | +If your file is located inside the `docs` folder it will get automatically interpreted by the mk-docs framework. |
39 | 37 |
|
40 | 38 | ## Updating the deployed website |
41 | 39 |
|
42 | | -Once you're done, `add` your changes, `commit`, and `push`. The GitHub action will trigger, and the `gh-pages` branch will be updated with your changes (bot will deploy it as static website and push to the `gh-page` branch). |
| 40 | +Once you are done with (part of) your documentation, `add` your changes, `commit`, and `push` them to `main` branch. The GitHub action will trigger, and the `gh-pages` branch will be updated with your changes (bot will deploy it as static website and push to the `gh-page` branch). |
| 41 | + |
| 42 | +## Authors/Contributors |
| 43 | + |
| 44 | +[Simon Potocnak](https://github.com/wpsimon09), |
| 45 | +[Daniel Bartha](https://github.com/DanielBartha), |
| 46 | +[Kristers Gruzins](https://github.com/animepuika), |
| 47 | +[Bartosz Adamczyk](https://github.com/Bartan02), |
| 48 | +[Mārtiņš Greizis](https://github.com/MGreizis) |
0 commit comments