docarys

Yet another static web site utility for technical documentation
markdown documentation nodejs


Summary

Project Name docarys Project Url https://www.docarys.io
InceptionYear 2017-08-29 17:39:57 更新时间 2018-05-17 22:54:46
IssueManagement https://github.com/docarys/docarys/issues Licenses MIT
仓库地址 git+https://github.com/docarys/docarys.git 用户数 0
Node Engine 文件大小 21.6 KB
install test cover codacy-cover

项目介绍

[![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](http://www.docarys.io) 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 -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](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) 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.

Dependencys

GroupId ArtifactID Version 引用量
qix chalk 4.0.0 66811
TJ Holowaychuk commander 5.1.0 42562
Sergio Sisternes docarys-material 2.0.2 1
JP Richardson fs-extra 9.0.0 39543
Charlike Mike Reagent get-installed-path 4.0.8 129
Ivan Sagalaev highlight.js 10.0.3 5973
Tapio Vierros live-server 1.2.1 674
vitaly markdown-it 11.0.0 3848
Sergio Sisternes markdown-it-admonition 1.0.4 1
valeriangalliat markdown-it-anchor 5.3.0 1399
vitaly markdown-it-container 2.0.0 458
Valérian Galliat markdown-it-highlightjs 3.1.0 83
svbergerem markdown-it-sanitizer 0.4.3 6
Paul Vorbach md5 2.2.1 1755
isaacs mkdirp 1.0.4 25226
AvianFlu ncp 2.0.0 2778
James Long nunjucks 3.2.1 1809
Nicolas Gryman reading-time 1.2.0 15
Stian Grytøyr remove-markdown 0.3.0 57
Sascha Droste speakingurl 14.0.1 67
Mikeal Rogers watch 1.0.2 2746
Jeremy Faivre yamljs 0.3.0 1129

开发依赖

GroupId ArtifactID Version 引用量
David Pate codacy-coverage 3.4.0 736
cpojer expect 26.0.0 5924
Grunt Development Team grunt 1.1.0 37083
Grunt Team grunt-contrib-uglify 4.0.1 11205
Krishnan Anantheswaran istanbul 0.4.5 223
Oliver Nightingale lunr 2.3.8 295
mustache.js Authors mustache 4.0.1 3093
Tobias Koppers @sokra style-loader 1.2.1 53631