https://github.com/named-data/ndn-101
NDN 101 documentation
https://github.com/named-data/ndn-101
introduction ndn
Last synced: 4 months ago
JSON representation
NDN 101 documentation
- Host: GitHub
- URL: https://github.com/named-data/ndn-101
- Owner: named-data
- License: cc-by-sa-4.0
- Created: 2023-04-26T06:52:34.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-12-01T22:36:10.000Z (6 months ago)
- Last Synced: 2025-12-04T12:53:47.436Z (6 months ago)
- Topics: introduction, ndn
- Language: TeX
- Homepage: https://101.named-data.net
- Size: 712 KB
- Stars: 14
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: docs/security/introduction.md
Awesome Lists containing this project
README
# NDN 101
An introductory website on Named Data Networking (NDN).
Link: [101.named-data.net](https://101.named-data.net/)
## General Information
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/).
## Local Build
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:
```shell
# Option 1: install via pipx
pipx install poetry
# Option 2: install via uv
uv tool install poetry
```
After Poetry is installed, navigate to the project directory (i.e., ndn-101) and run the command below to install the required build dependencies:
```shell
poetry install
```
To start a live preview on your machine, you can run:
```shell
poetry run mkdocs serve
```
After running this command, the MkDocs development server should start on your local machine (default port number is 8000).
To build static web pages, use this command:
```shell
poetry run mkdocs build
```
## Contributing
You can contribute to the NDN 101 website by submitting a pull request on GitHub.