Introduction

docsify

A magical documentation site generator.

What it is

docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as a website. To start using it, all you need to do is create an index.html and deploy it on GitHub Pages.

See the Quick start guide for more details.

Features

  • No statically built html files
  • Simple and lightweight
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Emoji support
  • Compatible with IE11
  • Support server-side rendering (example)

Maintainers


Anix


Joe Pea


John Hildenbiddle


Koy


Luffy

Achievement
108
Star
20
Fork
People(2)
cinwell
1653262 sy records 1578956935 沈唁

Search

153430 a91d09cc 1899542 180418 42a90fc8 1899542