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

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

docarys

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

docarys is as magic as a dragon spitting fire 🐉 🔥


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 -g docarys docarys-material generator-docarys
`

To create a new project:
` sh
mkdir myproject
cd myproject
yo docarys
... (Follow the setup)
docarys serve
``

More details coming soon.

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

License

docarys is a Node enhaced port of MkDocs by Tom Christie

docarys-material is a hard-fork from mkdocs-material by Martin Donath

MIT License

Copyright (c) 2017 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 NONINFRINGEMENT. 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.

This project uses a hard-fork version of mkdocs-material, from 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
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.

This project is inspired by, and uses few software pieces from mkdocs project, by Tom Christie:

Copyright © 2014, Tom Christie. All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following
conditions are met:

Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.