Skip to content

athena0304/docsify

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

docsify

A magical documentation site generator.

Travis Status npm 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

Look at this tutorial or online demo.

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.
vue-sticker Vue component, that helps to make sticky effects
Ts.ED A TypeScript Framework on top of Express
Ts.LogDebug A multi channel logger written in TypeScript
vue-orgchart Vue.js wrapper for OrgChart.js
Vue Content Loading Easily build (or use presets) SVG loading cards Facebook like

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

About

๐Ÿƒ A magical documentation site generator.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 89.7%
  • CSS 9.3%
  • Other 1.0%