OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Added documentation how to run examples [ci skip]

Browse Source
This commit is contained in:
squidfunk 2017-06-20 18:57:35 +02:00 committed by Martin Donath
parent d85ef155de
commit a2261041dd
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
examples/README.md Normal file
View File

@ -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.