Merge pull request #32 from encode/docs-images

Add images for default and kelp themes

Author: lovelydinosaur

README.md

@@ -2,6 +2,8 @@
 
 MkDocs is a smart, simple, website design tool.
 
+![MkDocs](docs/img/mkdocs.png)
+
 ## Installation
 
 Install the `mkdocs` command line tool...
@@ -18,13 +20,13 @@ $ pip install git+https://github.com/encode/mkdocs.git
 2. Run `mkdocs serve` to view your documentation in a browser.
 3. Run `mkdocs build` to build a static website ready to host.
 
-*MkDocs supports [GitHub Flavored Markdown](writing.md) for page authoring.*
+*MkDocs supports [GitHub Flavored Markdown](docs/writing.md) for page authoring.*
 
 ## Writing your docs
 
 1. Create additional markdown pages.
-2. Use [markdown interlinking](navigation.md#interlinking) between pages.
-3. Create a `mkdocs.toml` file to define [the site navigation](navigation.md#navigation) and other configuration.
+2. Use [markdown interlinking](docs/navigation.md#interlinking) between pages.
+3. Create a `mkdocs.toml` file to define [the site navigation](docs/navigation.md#navigation) and other configuration.
 4. Move your markdown pages into a `docs` directory, and update the config.
 
 An example `mkdocs.toml`...
@@ -45,14 +47,18 @@ title = "Documentation"
 favicon = "📘"
 ```
 
-*Use either [`README.md` or `index.md`](navigation.md#url-structure) for the homepage.*
+*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.
 
 1. Configure the base theme for your project.
-2. Modify [the HTML templating](styling.md#templates) to customise the layout.
-3. Override or add [CSS and JavaScript](styling.md#statics) static assets.
+2. Modify [the HTML templating](docs/styling.md#templates) to customise the layout.
+3. Override or add [CSS and JavaScript](docs/styling.md#statics) static assets.
 
 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.*

docs/img/kelp.png

@@ -2,6 +2,8 @@
 
 MkDocs is a smart, simple, website design tool.
 
+![MkDocs](img/mkdocs.png)
+
 ## Installation
 
 Install the `mkdocs` command line tool...
@@ -56,3 +58,7 @@ Styling adaptations can be kept simple, such as customising the colour scheme, o
 3. Override or add [CSS and JavaScript](styling.md#statics) static assets.
 
 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](img/kelp.png)
+
+*The MkDocs documentation, served with the Kelp theme.*