diff --git a/README.md b/README.md index 263b56f..b4016ea 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ MkDocs is a smart, simple, website design tool. ![MkDocs](docs/img/mkdocs.png) +
+ ## Installation Install the `mkdocs` command line tool... @@ -22,6 +24,8 @@ $ pip install git+https://github.com/encode/mkdocs.git *MkDocs supports [GitHub Flavored Markdown](docs/writing.md) for page authoring.* +
+ ## Writing your docs 1. Create additional markdown pages. @@ -49,6 +53,8 @@ favicon = "📘" *Use either [`README.md` or `index.md`](docs/navigation.md#url-structure) for the homepage.* +
+ ## Custom styling Styling adaptations can be kept simple, such as customising the colour scheme, or more comprehensive, such as creating an entirely new theme. @@ -59,6 +65,8 @@ Styling adaptations can be kept simple, such as customising the colour scheme, o Take a look at the [default theme](https://github.com/lovelydinosaur/mkdocs-theme) and the [kelp theme](https://github.com/lovelydinosaur/kelp-theme) for examples of getting started with theming. +
+ ![Kelp](docs/img/kelp.png) *The MkDocs documentation, served with the Kelp theme.*