From 31ad4ae205a8593c56a150712cb49e143f146651 Mon Sep 17 00:00:00 2001 From: Tanguy Date: Thu, 1 Dec 2022 12:20:17 +0100 Subject: [PATCH] Fix website (#812) --- examples/README.md | 7 +++---- examples/index.md | 6 ++++++ mkdocs.yml | 6 +++--- 3 files changed, 12 insertions(+), 7 deletions(-) create mode 100644 examples/index.md diff --git a/examples/README.md b/examples/README.md index 07600735e..1c4140189 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,6 +1,5 @@ -# nim-libp2p documentation +# nim-libp2p examples -Welcome to the nim-libp2p documentation! +In this folder, you'll find the sources of the [nim-libp2p website](https://status-im.github.io/nim-libp2p/docs/) -Here, you'll find [tutorials](tutorial_1_connect.md) to help you get started, as well as -the [full reference](https://status-im.github.io/nim-libp2p/master/libp2p.html). +We recommand to follow the tutorials on the website, but feel free to grok the sources here! diff --git a/examples/index.md b/examples/index.md new file mode 100644 index 000000000..07600735e --- /dev/null +++ b/examples/index.md @@ -0,0 +1,6 @@ +# nim-libp2p documentation + +Welcome to the nim-libp2p documentation! + +Here, you'll find [tutorials](tutorial_1_connect.md) to help you get started, as well as +the [full reference](https://status-im.github.io/nim-libp2p/master/libp2p.html). diff --git a/mkdocs.yml b/mkdocs.yml index e9cdaacd6..94e406927 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -20,8 +20,8 @@ markdown_extensions: - pymdownx.superfences theme: - logo: https://docs.libp2p.io/images/logo_small.png - favicon: https://docs.libp2p.io/images/logo_small.png + logo: https://libp2p.io/img/logo_small.png + favicon: https://libp2p.io/img/logo_small.png name: material features: - navigation.instant @@ -41,7 +41,7 @@ theme: nav: - Tutorials: - - 'Introduction': README.md + - 'Introduction': index.md - 'Simple connection': tutorial_1_connect.md - 'Create a custom protocol': tutorial_2_customproto.md - 'Protobuf': tutorial_3_protobuf.md