[![Travis][travis-image]][travis-link]
[![Codacy][codacy-image]][codacy-link]
[![npm][npm-image]][npm-link]

  [travis-image]: https://travis-ci.org/docarys-material/docarys-material.svg?branch=master
  [travis-link]: https://travis-ci.org/docarys/docarys-material
  [codacy-image]: https://api.codacy.com/project/badge/Grade/b09d43c36b064fe492d577b6329e012c
  [codacy-link]: https://www.codacy.com/app/sesispla/docarys-material?utm_source=github.com&utm_medium=referral&utm_content=docarys/docarys-material&utm_campaign=Badge_Grade
  [npm-image]: https://img.shields.io/npm/dt/docarys-material.svg
  [npm-link]: hhttps://www.npmjs.com/package/docarys-material

# Material for docarys

A Material Design theme for [docarys](http://www.docarys.io).

docarys is yet another static site generator. Simple. Flexible. Customizable. Period.

docarys is as magic as a dragon spitting fire 🐉 🔥

[![Material for docarys](docs/material.png)](https://github.com/docarys/docarys-material)

Based in concepts from mkdocs, hard-forked from mkdocs-material, inspired by Microsoft Docs, and built on top of Node.JS.

## Quick start

Install with `npm`:

``` sh
npm install docarys-material
```

Append the following line to your existing `mkdocs.yml`:

``` yaml
theme: 'material'
```

## What to expect

* Responsive design and fluid layout for all kinds of screens and devices,
  designed to serve your project documentation in a user-friendly way in 25
  languages with optimal readability.

* Easily customizable primary and accent color, fonts, favicon and logo;
  straight forward localization through theme extension; integrated with Google
  Analytics, Disqus and GitHub.

* Well-designed search interface accessible through hotkeys (<kbd>F</kbd> or
  <kbd>S</kbd>), intelligent grouping of search results, search term
  highlighting and lazy loading.

For detailed installation instructions and a demo, visit
http://www.docarys.io

## License

docarys is a Node port (with enhacements) of [MkDocs](https://github.com/mkdocs/mkdocs) by Tom Christie

docarys-material is a hard-fork from [mkdocs-material](https://github.com/squidfunk/mkdocs-material) by Martin Donath

**MIT License**

Copyright (c) 2016-2017 Martin Donath, Sergio Sisternes

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
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.