centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 18:08:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #391 from d0ugal/doc-tweaks

Browse Source 
Some minor docs updates
This commit is contained in:
Dougal Matthews
2015-04-02 09:42:58 +01:00
parent 9b0aa1f872 724ec03de9
commit 9efe16bc56
3 changed files with 9 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -5,9 +5,7 @@
[![Build Status][travis-image]][travis-link]
[![Coverage Status][coveralls-image]][coveralls-link]
Background: https://groups.google.com/forum/#!topic/django-rest-framework/YJ6J3jocGlo
**See in progress docs: [www.mkdocs.org](http://www.mkdocs.org)**
**See the MkDocs documentation: [www.mkdocs.org](http://www.mkdocs.org)**
Release notes: http://www.mkdocs.org/about/release-notes/
@@ -15,7 +13,9 @@ Project roadmap: [https://github.com/tomchristie/mkdocs/wiki](https://github.com
IRC channel: `#mkdocs` on freenode.
[travis-image]: https://travis-ci.org/tomchristie/mkdocs.png?branch=master
[travis-link]: https://travis-ci.org/tomchristie/mkdocs
[coveralls-image]: https://coveralls.io/repos/tomchristie/mkdocs/badge.png?branch=master
[coveralls-link]: https://coveralls.io/r/tomchristie/mkdocs?branch=master
Discussions and support: https://groups.google.com/forum/#!forum/mkdocs
[coveralls-image]: https://coveralls.io/repos/mkdocs/mkdocs/badge.png
[coveralls-link]: https://coveralls.io/r/mkdocs/mkdocs
[travis-image]: https://travis-ci.org/mkdocs/mkdocs.png?branch=master
[travis-link]: https://travis-ci.org/mkdocs/mkdocs

6
docs/index.md
View File

@@ -12,7 +12,7 @@ MkDocs is a **fast**, **simple** and **downright gorgeous** static site generato
**MkDocs is currently still in development.**
We're progressing quickly, but the documentation still needs filling in, and theres a few rough edges. The 1.0 release is planned to arrive in the next few weeks.
We're progressing quickly, but the documentation still needs filling in, and theres a few rough edges. The 1.0 release is planned to arrive in the next few months.
---
@@ -32,10 +32,6 @@ The built-in devserver allows you to preview your documentation as you're writin
Get your project documentation looking just the way you want it by customizing the theme.
#### Cross-reference your documentation.
Create richly cross-referenced documents, using the MkDocs interlinking syntax.
---
## Installation

2
docs/user-guide/styling-your-docs.md
View File

@@ -16,7 +16,7 @@ How to style and theme your documentation.
#### The bootswatch themes
![Amelia](http://bootswatch.com/amelia/thumbnail.png)
![Amelia](http://bootswatch.com/2/amelia/thumbnail.png)
![Cerulean](http://bootswatch.com/cerulean/thumbnail.png)