Total Pageviews

Sunday, 30 July 2017

一个基于nodejs的文档网站生成器-docsify

A magical documentation site generator. 
Travis Status npm cdnjs donate 

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 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 😊
ProjectDescription
SnipasteSnip & Paste
puckA small & magical php framework.
SamaritanAn Algorithmic Trading Framework for Digital Currency.
VudashPowerful, Flexible, Open Source dashboards for anything
TrilogyNo-hassle SQLite with a Promise-based, document store style API.
Mybatis-PlusAn enhanced toolkit of Mybatis to simplify development
JS MythBustersAn optimization handbook from a high level point of view.
hire-meA path to getting an awesome tech gig.
vue-amapA Map Component Library Base on Vue 2.x and Gaode Map.
samlifyNode.js SAML2 library
palettifyA color palette effects assistant
commitlintLint commit messages
vue-data-tablesA simple and customizable data table,based on vue2 and element-ui.
NotyA Dependency-free notification library

Similar projects

ProjectDescription
docute📜 Effortlessly documentation done right
docpressDocumentation 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
from https://github.com/QingWei-Li/docsify
要添加更多的页面,见此:https://docsify.now.sh/more-pages
--------------------------------------------------------------

docsify-ssr-demo

Deploy

npm i
npm run deploy
from https://github.com/QingWei-Li/docsify-ssr-demo

No comments:

Post a Comment

Note: only a member of this blog may post a comment.