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 и запустите его на любом статическом веб-сервере или через GitHub Pages, либо начните с краткого руководства (quick start) или примера на CodeSandbox. Есть и официальный Docsify CLI.
Что у меня должно быть установлено?Для сайта с документацией не нужно ничего, кроме браузера — Docsify подгружается с CDN (UNPKG, jsDelivr или cdnjs). Node.js 20.11+ требуется только для работы над исходным кодом самого Docsify.
Что есть из коробки?Плагин умного полнотекстового поиска, несколько тем, API плагинов для нестандартного поведения и поддержка эмодзи — всё просто и легко.
Где посмотреть реальные сайты, сделанные на Docsify?Подборка awesome-docsify собирает большое количество проектов-примеров, созданных с его помощью.
Creator
docsifyjs
Size
31.4 MB
Stars
31.5K
Age
9y
Commits · 90 Days