docsify README

The project's README from github.com/docsifyjs/docsify. As one markdown file: README.md.

docsify

A magical documentation site generator.

Backers on Open Collective Sponsors on Open Collective Build & Test npm Join Discord community and chat about Docsify Gitpod Ready-to-Code

Gold Sponsor via Open Collective

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

Features

Quick Start

Get going fast by using a static web server or GitHub Pages with this ready-to-use Docsify Template, review the quick start tutorial or jump right into a CodeSandbox example site with the button below.

Edit in CodeSandbox

Showcase

A large collection of showcase projects are included in awesome-docsify.

Contributing

See CONTRIBUTING.md.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Thank you for supporting this project! ❤️ [Become a sponsor]

Contributors

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

License

MIT

docsify (docsifyjs/docsify)

Searching Database…

31.5K ·GitHub
这是做什么的?Docsify 能把你的 Markdown 文件变成一个文档网站:你只管写 Markdown,它就会自动生成一个网站,完全不需要构建过程。
那它是把文档编译成 HTML 的构建工具,还是在页面里直接运行的?它是即时渲染你的 Markdown,而不是预先生成 HTML 文件,所以没有什么需要编译的——访客打开页面时,网站就自己组装好了。
我怎么才能把一个文档网站搭起来?拿现成的 Docsify 模板,用任意静态 Web 服务器或 GitHub Pages 托管就行;也可以从快速上手教程或 CodeSandbox 示例开始。官方还提供了 Docsify CLI。
我需要提前装些什么?文档网站只需要一个浏览器——Docsify 从 CDN(UNPKG、jsDelivr 或 cdnjs)加载。只有参与 Docsify 自身源码开发时才需要 Node.js 20.11+。
它开箱自带哪些功能?有智能全文搜索插件、多套主题、用于自定义行为的插件 API,还支持 emoji——一切都保持简单轻量。
在哪里能看到用 Docsify 搭建的真实网站?awesome-docsify 这个合集收录了大量用 Docsify 搭建的展示项目。
Creator
docsifyjs
Size
31.4 MB
Stars
31.5K
Age
9y
Commits · 90 Days