From a2261041dd2b183ffeb0047f0ad569202ec9d274 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Tue, 20 Jun 2017 18:57:35 +0200 Subject: [PATCH] Added documentation how to run examples [ci skip] --- examples/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 examples/README.md diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 000000000..c148b914d --- /dev/null +++ b/examples/README.md @@ -0,0 +1,14 @@ +# Examples + +To run the example configurations, ensure Python and MkDocs are up and running, +change to the respective directory and run `mkdocs serve`. This will print: + +``` sh +INFO - Building documentation... +INFO - Cleaning site directory +[I 170620 18:54:55 server:283] Serving on http://127.0.0.1:8000 +[I 170620 18:54:55 handlers:60] Start watching changes +[I 170620 18:54:55 handlers:62] Start detecting changes +``` + +Go to http://127.0.0.1:8000 to see the resulting documentation.