From 2cc96573d644679f474d4bd7c9136b4d021fd73a Mon Sep 17 00:00:00 2001 From: Solid Studio Date: Sat, 4 Jul 2020 12:39:54 +0100 Subject: [PATCH] added docs --- docs/index.md | 17 +++++++++++++++++ mkdocs.yml | 4 ++++ 2 files changed, 21 insertions(+) create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000000..d3880397a9 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,17 @@ +# Welcome to MkDocs + +For full documentation visit [mkdocs.org](https://mkdocs.org). + +## Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs help` - Print this help message. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000000..b12b460a95 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,4 @@ +site_name: Remix Ethdoc +nav: + - Home: index.md +theme: readthedocs \ No newline at end of file