nim-libp2p/mkdocs.yml

53 lines
1.3 KiB
YAML
Raw Normal View History

2022-07-26 10:44:26 +00:00
site_name: nim-libp2p
repo_url: https://github.com/status-im/nim-libp2p
repo_name: status-im/nim-libp2p
site_url: https://status-im.github.io/nim-libp2p/docs
2022-09-28 08:40:53 +00:00
# Can't find a way to point the edit to the .nim instead
# of the .md
edit_uri: ''
2022-07-26 10:44:26 +00:00
docs_dir: examples
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- admonition
- pymdownx.details
- pymdownx.superfences
theme:
logo: https://docs.libp2p.io/images/logo_small.png
favicon: https://docs.libp2p.io/images/logo_small.png
name: material
features:
- navigation.instant
- search.highlight
palette:
- scheme: default
primary: blue grey
toggle:
icon: material/toggle-switch
name: Switch to dark mode
- scheme: slate
primary: blue grey
toggle:
icon: material/toggle-switch-off-outline
name: Switch to light mode
nav:
- Tutorials:
- 'Introduction': README.md
2022-09-28 08:40:53 +00:00
- 'Simple connection': tutorial_1_connect.md
- 'Create a custom protocol': tutorial_2_customproto.md
2022-09-29 08:28:58 +00:00
- 'Protobuf': tutorial_3_protobuf.md
2022-10-21 15:00:36 +00:00
- 'GossipSub': tutorial_4_gossipsub.md
- 'Discovery Manager': tutorial_5_discovery.md
- 'Game': tutorial_6_game.md
2022-09-28 08:40:53 +00:00
- 'Circuit Relay': circuitrelay.md
2022-07-26 10:44:26 +00:00
- Reference: '/nim-libp2p/master/libp2p.html'