加入CODE CHINA

· 不限速    · 不限空间    · 不限人数    · 私仓免费

免费加入
    README.md

    docsify

    A magical documentation site generator.

    Backers on Open Collective Sponsors on Open Collective Unit tests Suite Linting Checks Testing the e2e test suites npm donate Join Discord community and chat about Docsify Gitpod Ready-to-Code

    Gold Sponsor via Open Collective

    Links

    Features

    • No statically built html files
    • Simple and lightweight
    • Smart full-text search plugin
    • Multiple themes
    • Useful plugin API
    • Compatible with IE11
    • Support SSR (example)
    • Support embedded files

    Quick start

    Look at this tutorial

    Edit 307qqv236

    Showcase

    These projects are using docsify to generate their sites. Pull requests welcome 😊

    Move to awesome-docsify

    Similar projects

    Project Description
    docute 📜 Effortlessly documentation done right
    docpress Documentation website generator

    Contributing

    Online one-click setup for Contributing

    You can use Gitpod(A free online VS Code-like IDE) for contributing. With single click it'll launch a workspace and automatically:

    • clone the docsify repo.
    • install the dependencies.
    • start npm run dev.

    So that you can start straight away.

    Open in Gitpod

    • Fork it!
    • Create your feature branch: git checkout -b my-new-feature
    • Commit your changes: git add . && git commit -m 'Add some feature'
    • Push to the branch: git push origin my-new-feature
    • Submit a pull request

    Development

    npm run bootstrap && npm run dev

    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]

    Contributors

    This project exists thanks to all the people who contribute. [Contribute].

    License

    MIT

    Special Thanks

    Vercel has given us a Pro account.

    项目简介

    🚀 Github 镜像仓库 🚀

    源项目地址

    https://github.com/docsifyjs/docsify

    发行版本 11

    v4.12.1

    全部发行版

    贡献者 177

    全部贡献者

    开发语言

    • JavaScript 89.3 %
    • Stylus 8.9 %
    • HTML 1.5 %
    • Shell 0.4 %