You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documentation/README.md
+3-17Lines changed: 3 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,26 +14,12 @@ To build the docs locally, you will have to first install [uv](https://github.co
14
14
Once that is done, you can run the following commands (while inside this folder):
15
15
16
16
```bash
17
-
uv sync # You only need to run this once, it will download all the necessary python packages
18
-
PDF=1 uv run mkdocs serve -a localhost:8888 # This will build the site and serve it on localhost:8888
17
+
uv sync --frozen # You only need to run this once, it will download all the necessary python packages
18
+
uv run zensical serve -a localhost:8888 # This will build the site and serve it on localhost:8888
19
19
```
20
20
21
21
Open [localhost:8888](http://localhost:8888/) in your browser and you will see the docs. Every changes you make will rebuild the documentation.
22
22
You can remove the `PDF=1` environement variable if you want to speed up the build process, but you will not generate the related PDF.
23
23
24
-
25
-
### Versioning
26
-
We use the [mike](https://github.com/jimporter/mike) plugin to preserve multiple version of the docs.
27
-
28
-
To use it, you can run the following command:
29
-
```bash
30
-
PDF=1 uv run mike deploy -u dev # This will create the site and push the changes in the gh-pages branch
31
-
uv run mike serve -a localhost:8888 # Serve the site on localhost:8888
32
-
```
33
-
Check the official Github page of the plugin for more information on how it works.
34
-
35
24
## Images and Assets
36
-
Images and assets are saved in the `_attachments` folder closest to the documentation file that calls for the image. If an image is used in multiple different places, then it should be put in `_attachements` folder in the `docs/` root directory.
37
-
38
-
## Github workflow
39
-
We have Github workflows set up to automatically rebuild the docs when the `develop` branch receives changes, and when a new tag is created for the `master` branch.
25
+
Images and assets are saved in the `_attachments` folder closest to the documentation file that calls for the image. If an image is used in multiple different places, then it should be put in `_attachements` folder in the `docs/` root directory.
0 commit comments