Skip to content

Repository files navigation

docsify

A magical documentation site generator.

Travis StatusnpmChatdonate

Glod Sponsor via Open Collective

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

Look at this tutorial or online demo.

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 docsifynt 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
xTekoAddins framework for Pin 3.0
vue2-datatable-componentThe best Datatable for Vue.js 2.x which never sucks
SolidarityEnvironment enforcer for your projects across machines.
rnbackBackend service for react-native applications.
IT-filmsA curated list of awesome movies, documentaries and TV series about hackers, geeks and IT in common, sorted by IMDB rating.
zoomingImage zoom that makes sense.
vue-stickerVue component, that helps to make sticky effects
Ts.EDA TypeScript Framework on top of Express
Ts.LogDebugA multi channel logger written in TypeScript
vue-orgchartVue.js wrapper for OrgChart.js
Vue Content LoadingEasily build (or use presets) SVG loading cards Facebook like
preact-analysisPreact 源码解析
Tracy Debugger for ProcessWireThe ultimate debugging and development tool for the ProcessWire CMF/CMS
CBoardAn easy to use, self-service open BI reporting and BI dashboard platform.

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

Backers

Thank you to all our backers! πŸ™ [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

MIT

FOSSA Status

About

πŸƒ A magical documentation site generator.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages