Skip to content

Commit

Permalink
doc: Add paragraph about mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
fd0 committed Feb 21, 2016
1 parent f2b5434 commit c1f047b
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://restic.readthedocs.org>, 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.

0 comments on commit c1f047b

Please sign in to comment.