https://github.com/docsifyjs/docsify

🃏 A magical documentation site generator.
https://github.com/docsifyjs/docsify

doc docs docsify documentation documentation-tool github-pages markdown vue

Last synced: 3 days ago
JSON representation

🃏 A magical documentation site generator.

• Host: GitHub
• URL: https://github.com/docsifyjs/docsify
• Owner: docsifyjs
• License: mit
• Created: 2016-11-20T07:55:43.000Z (about 8 years ago)
• Default Branch: develop
• Last Pushed: 2024-11-19T09:04:58.000Z (23 days ago)
• Last Synced: 2024-12-01T04:35:44.073Z (11 days ago)
• Topics: doc, docs, docsify, documentation, documentation-tool, github-pages, markdown, vue
• Language: JavaScript
• Homepage: https://docsify.js.org
• Size: 28.9 MB
• Stars: 27,854
• Watchers: 268
• Forks: 5,679
• Open Issues: 188
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome - docsifyjs/docsify - 🃏 A magical documentation site generator. (JavaScript)
• awesome - docsify - 🃏 A magical documentation site generator. (JavaScript)
• awesome-nodejs - docsify - 🃏 A magical documentation site generator.  (Repository / Documentation)
• awesome-nodejs-cn - docsify - **star:27729** 标记文件网站生成器，没有静态构建的HTML文件 ![star > 2000][Awesome] (包 / 静态网站生成器)
• awesome-starred-test - docsifyjs/docsify - 🃏 A magical documentation site generator. (JavaScript)
• awesome - docsifyjs/docsify - 🃏 A magical documentation site generator. (JavaScript)
• awesome-repositories - docsifyjs/docsify - 🃏 A magical documentation site generator. (JavaScript)
• awesome-github-star - docsify
• awesome-list - docsify 文档站生成器
• awesome-starred - docsifyjs/docsify - 🃏 A magical documentation site generator. (vue)
• awesome-list - docsify
• awesome-nodejs - docsify - Markdown documentation site generator with no statically built HTML files. (Packages / Static site generators)
• awesome-side-project - DocsifyJs - a "magical" documentation site generator. Has [addons and plugins](https://github.com/docsifyjs/awesome-docsify). (📦 Package / User support)
• StarryDivineSky - docsifyjs/docsify
• awesome-documentation - Docsify - A magical documentation site generator. (General Tools / Site Builder)
• awesome - docsifyjs/docsify - 🃏 A magical documentation site generator. (JavaScript)
• awesome - docsifyjs/docsify - 🃏 A magical documentation site generator. (JavaScript)
• jimsghstars - docsifyjs/docsify - 🃏 A magical documentation site generator. (JavaScript)

README

        


  

    

  





  A magical documentation site generator.





  

  

    

  

  

  

  



Gold Sponsor via Open Collective




  

    

  



Docsify turns one or more Markdown files into a Website, with no build process required.

## Features

- No statically built html files

- Simple and lightweight

- Smart full-text search plugin

- Multiple themes

- Useful plugin API

- Emoji support

## Quick Start

Get going fast by using a static web server or GitHub Pages with this ready-to-use [Docsify Template](https://github.com/docsifyjs/docsify-template), review the [quick start tutorial](https://docsify.js.org/#/quickstart) or jump right into a CodeSandbox example site with the button below.

[![Edit 307qqv236](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236)

## Showcase

A large collection of showcase projects are included in [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase).

## Links

- [Documentation](https://docsify.js.org)

- [Docsify CLI (Command Line Interface)](https://github.com/docsifyjs/docsify-cli)

- CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify)

- [`develop` branch preview](https://docsify-preview.vercel.app/)

- [Awesome docsify](https://github.com/docsifyjs/awesome-docsify)

- [Community chat](https://discord.gg/3NwKFyR)

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md).

## Backers

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/docsify/contribute)]



## Sponsors

Thank you for supporting this project! ❤️ [[Become a sponsor](https://opencollective.com/docsify/contribute)]



## Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].



## License

[MIT](LICENSE)

## Special Thanks

A preview of Docsify's PR and develop branch is Powered by