From ce9ca56142e62adebf13257dbc6c5d56e668061d Mon Sep 17 00:00:00 2001 From: squidfunk Date: Thu, 12 Jan 2017 00:49:28 +0100 Subject: [PATCH] Update README and index page --- README.md | 26 +++++++++++------------ docs/index.md | 59 +++++++++++++++++++++++---------------------------- 2 files changed, 40 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 0f4205ffd..78ca711a3 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,19 @@ # Material -[![Travis CI][travis-image]][travis-link] -[![PyPI Downloads][pypi-dl-image]][pypi-dl-link] -[![PyPI Version][pypi-v-image]][pypi-v-link] +[![Travis][travis-image]][travis-link] +[![Codacy][codacy-image]][codacy-link] +[![PyPI][pypi-image]][pypi-link] -A material design theme for [MkDocs 0.16](http://www.mkdocs.org). +A material design theme for [MkDocs](http://www.mkdocs.org). -[![iOS](docs/images/screen.png)](http://squidfunk.github.io/mkdocs-material/) +TBD: [![_](docs/images/screen.png)](http://squidfunk.github.io/mkdocs-material/) + + [travis-image]: https://travis-ci.org/squidfunk/mkdocs-material.svg + [travis-link]: https://travis-ci.org/squidfunk/mkdocs-material + [codacy-image]: https://api.codacy.com/project/badge/Grade/fe07aa1fa91d453cb69711d3885c5d7e + [codacy-link]: https://www.codacy.com/app/squidfunk/mkdocs-material?utm_source=github.com&utm_medium=referral&utm_content=squidfunk/mkdocs-material&utm_campaign=Badge_Grade + [pypi-image]: https://img.shields.io/pypi/v/mkdocs-material.svg + [pypi-link]: https://pypi.python.org/pypi/mkdocs-material ## Quick start @@ -29,7 +36,7 @@ http://squidfunk.github.io/mkdocs-material/ **MIT License** -Copyright (c) 2016 Martin Donath +Copyright (c) 2016-2017 Martin Donath Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to @@ -48,10 +55,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -[travis-image]: https://travis-ci.org/squidfunk/mkdocs-material.svg -[travis-link]: https://travis-ci.org/squidfunk/mkdocs-material -[pypi-dl-image]: https://img.shields.io/pypi/dm/mkdocs-material.png -[pypi-dl-link]: https://pypi.python.org/pypi/mkdocs-material -[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-material.png -[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material diff --git a/docs/index.md b/docs/index.md index a71195f7c..b4ac2f8b9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,14 +3,13 @@ ## Build beautiful documentation Material is a theme for [MkDocs][1], an excellent static site generator geared -towards project documentation. It is built using Google's [material design][2] -guidelines, full responsive, optimized for touch and pointer devices as well -as all sorts of screen sizes. +towards project documentation. It is built using Google's [Material Design][2] +guidelines, fully responsive and optimized for touch and pointer devices. Material is very lightweight – it is built from scratch using Javascript and -CSS that weighs less than 30kb (minified, gzipped and excluding Google Fonts -and Analytics). Yet, it is highly customizable and degrades gracefully in older -browsers. +CSS that weighs approximately 30kb (minified, gzipped and excluding Google +Fonts and Analytics). Yet, it is highly customizable and degrades gracefully in +older browsers. [1]: http://www.mkdocs.org [2]: https://www.google.com/design/spec/material-design @@ -29,38 +28,34 @@ Add the following line to your `mkdocs.yml`: theme: 'material' ``` +For detailed instructions see the [getting started guide][3]. + + [3]: getting-started.md + ## Features -- Beautiful, readable and very user-friendly design based on Google's material - design guidelines, packed in a full responsive template with a well-defined - and [easily customizable color palette][], great typography, as well as a - beautiful search interface and footer. +* Beautiful, readable and very user-friendly design based on Google's Material + Design guidelines, packed in a full responsive template with a well-defined + and [easily customizable color palette][4], great typography, as well as a + beautiful search interface. -- Well-tested and optimized Javascript and CSS including a cross-browser - fixed/sticky header, a drawer that even works without Javascript using - the [checkbox hack][] with fallbacks, responsive tables that scroll when - the screen is too small and well-defined print styles. +* Responsive specimen like code blocks, tables that work on all screen sizes, + working with and without JavaScript which makes it gracefully degrade in + older browsers. -- Extra configuration options like a [project logo][], links to the authors - [GitHub and Twitter accounts][], display of the amount of stars the - project has on GitHub and [Google Analytics integration][]. +- Extra configuration options like a [project logo][5], links to + [social accounts][6], display of the amount of stars your project has on + GitHub and [Google Analytics integration][7]. -- Easily [extendable and customizable][] due to a well-designed asset pipeline - built on-top of [Gulp][] with `npm` and `bower` and modular and abstracted - style definitions built with [SASS][]. +- Easily [extendable and customizable][8] due to a well-designed asset pipeline + built on-top of modern web technologies and modular and abstracted + style definitions.. - Web application capability on iOS – when the page is saved to the homescreen, it behaves and looks like a native application. -See the [getting started guide](getting-started.md) for instructions how to get -it up and running. - - -[checkbox hack]: http://tutorialzine.com/2015/08/quick-tip-css-only-dropdowns-with-the-checkbox-hack/ -[project logo]: getting-started.md#adding-a-logo -[easily customizable color palette]: getting-started.md#changing-the-color-palette -[GitHub and Twitter accounts]: getting-started.md#adding-a-github-and-twitter-account -[Google Analytics integration]: getting-started.md#google-analytics-integration -[extendable and customizable]: customization.md -[Gulp]: http://gulpjs.com -[SASS]: http://sass-lang.com + [4]: getting-started.md#changing-the-color-palette + [5]: getting-started.md#adding-a-logo + [6]: getting-started.md#adding-social-links + [7]: getting-started.md#google-analytics-integration + [8]: customization.md