octoleo/restic
2
2
Fork 0
mirror of https://github.com/octoleo/restic.git synced 2024-11-30 00:33:57 +00:00
Code Issues Releases Wiki Activity

doc: Add paragraph about mkdocs

Browse Source
This commit is contained in:
Alexander Neumann 2016-02-21 13:04:45 +01:00
parent 45e9561b48
commit 1edf9c1ee4
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/index.md
View File

@ -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 right documentation in the directory `doc/`. If you're viewing this online at
<https://restic.readthedocs.org>, there is a small menu at the bottom left of <https://restic.readthedocs.org>, there is a small menu at the bottom left of
this page, where you can select the version. 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.