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
This documentation website is made using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). The website structure can be found in [`mkdocs.yml`](mkdocs.yml). Build dependencies are managed with [Poetry](https://python-poetry.org/).
10
+
11
+
## Local Build
12
+
13
+
First you should install Poetry for dependency management. We recommend using [pipx](https://pipx.pypa.io/) or [uv](https://docs.astral.sh/uv/) to install Poetry in a dedicated virtual environment. For example, you can install Poetry by running:
10
14
11
15
```shell
16
+
# Option 1: install via pipx
12
17
pipx install poetry
18
+
19
+
# Option 2: install via uv
20
+
uv tool install poetry
21
+
```
22
+
23
+
After Poetry is installed, navigate to the project directory (i.e., ndn-101) and run the command below to install the required build dependencies:
24
+
25
+
```shell
13
26
poetry install
14
27
```
15
28
16
-
Live preview:
29
+
To start a live preview on your machine, you can run:
17
30
18
31
```shell
19
32
poetry run mkdocs serve
20
33
```
34
+
35
+
After running this command, the MkDocs development server should start on your local machine (default port number is 8000).
36
+
37
+
To build static web pages, use this command:
38
+
39
+
```shell
40
+
poetry run mkdocs build
41
+
```
42
+
43
+
## Contributing
44
+
45
+
You can contribute to the NDN 101 website by submitting a pull request on GitHub.
0 commit comments