Skip to content

Commit

Permalink
docs: add guide for starting MkDocs locally
Browse files Browse the repository at this point in the history
  • Loading branch information
predragnikolic committed Nov 18, 2020
1 parent 0e987e2 commit a6e91cf
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Welcome to MkDocs

Install MkDocs - https://www.mkdocs.org/#installing-mkdocs

For full documentation visit [mkdocs.org](https://www.mkdocs.org).

## Commands

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.

## Project layout

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.

Useful links:

- Material for MkDocs
https://squidfunk.github.io/mkdocs-material/

- Admonitions (tip, warning, info boxes)
https://squidfunk.github.io/mkdocs-material/reference/admonitions/

0 comments on commit a6e91cf

Please sign in to comment.