From c1f047bcc60e8da34b82c1c30b28f19e06456b13 Mon Sep 17 00:00:00 2001 From: Alexander Neumann Date: Sun, 21 Feb 2016 13:04:45 +0100 Subject: [PATCH] doc: Add paragraph about mkdocs --- doc/index.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/index.md b/doc/index.md index 51bed2e27..b0512bfba 100644 --- a/doc/index.md +++ b/doc/index.md @@ -13,3 +13,13 @@ you have installed. If you cloned the repository manually, you can find the right documentation in the directory `doc/`. If you're viewing this online at , there is a small menu at the bottom left of this page, where you can select the version. + +The restic documentation is built with [MkDocs](http://www.mkdocs.org). After +installing it, you can edit and view the documentation locally by running: + + $ mkdocs serve + INFO - Building documentation... + INFO - Cleaning site directory + [I 160221 12:33:57 server:271] Serving on http://127.0.0.1:8000 + +Afterwards visit the URL with a browser.