1 Star 0 Fork 0

Bear Kuro/docsify

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

docsify

A magical documentation site generator.

Travis Status npm cdnjs donate

Sponsor

Links

Features

  • No statically built html files
  • Simple and lightweight (~18kB gzipped)
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Compatible with IE10+
  • Support SSR (example)

Quick start

Create an index.html.

<!-- index.html -->

<!DOCTYPE html>
<html>
<head>
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  <meta name="viewport" content="width=device-width,initial-scale=1">
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
</head>
<body>
  <div id="app"></div>
  <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
</body>
</html>

Browser Support

Modern browsers and Internet Explorer 10+.

Showcase

These projects are using docsify to generate their sites. Pull requests welcome

Project Description
Snipaste Snip & Paste
puck A small & magical php framework.
Samaritan An Algorithmic Trading Framework for Digital Currency.
Vudash Powerful, Flexible, Open Source dashboards for anything
Trilogy No-hassle SQLite with a Promise-based, document store style API.
Mybatis-Plus An enhanced toolkit of Mybatis to simplify development
JS MythBusters An optimization handbook from a high level point of view.
hire-me A path to getting an awesome tech gig.
vue-amap A Map Component Library Base on Vue 2.x and Gaode Map.
samlify Node.js SAML2 library
palettify A color palette effects assistant
commitlint Lint commit messages
vue-data-tables A simple and customizable data table,based on vue2 and element-ui.
Noty A Dependency-free notification library
xTeko Addins framework for Pin 3.0
vue2-datatable-component The best Datatable for Vue.js 2.x which never sucks
Solidarity Environment enforcer for your projects across machines.
rnback Backend service for react-native applications.
IT-films A curated list of awesome movies, documentaries and TV series about hackers, geeks and IT in common, sorted by IMDB rating.
zooming Image zoom that makes sense.

Similar projects

Project Description
docute 📜 Effortlessly documentation done right
docpress Documentation website generator

Contributing

  • Fork it!
  • Create your feature branch: git checkout -b my-new-feature
  • Commit your changes: git commit -am 'Add some feature'
  • Push to the branch: git push origin my-new-feature
  • Submit a pull request

Development

npm run bootstrap && npm run dev
open http://localhost:3000

License

MIT

FOSSA Status

MIT License Copyright (c) 2016 - 2017 cinwell.li 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.

简介

暂无描述 展开 收起
README
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
JavaScript
1
https://gitee.com/KuroBear/docsify.git
git@gitee.com:KuroBear/docsify.git
KuroBear
docsify
docsify
master

搜索帮助