Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/docsifyjs/docs-ru

:black_joker: A magical documentation site generator.
https://github.com/docsifyjs/docs-ru

Last synced: about 7 hours ago
JSON representation

:black_joker: A magical documentation site generator.

Awesome Lists containing this project

README

        

## docsify

> Магический генератор документации

## Что это такое

docsify генерирует ваш сайт документации на лету. В отличие от GitBook, он не генерирует статические HTML-файлы. Вместо этого он по-умному загружает и парсит ваши файлы в формате Markdown и отображает их в виде веб-сайта. Всё, что вам нужно сделать, это создать `index.html` для запуска и [развернуть его на GitHub Pages](/ru-ru/deploy.md).

Смотрите дополнительную информацию в разделе [Быстрый старт](/ru-ru/quickstart.md).

## Особенности

* Нет статически созданных файлов HTML
* Простой и легковесный (~19kB gzipped)
* Умный полнотекстовый поиск через плагин
* Различные темы
* Удобный API плагинов
* Поддержка Emoji
* Совместимость с IE10+
* Поддержка SSR ([пример](https://github.com/QingWei-Li/docsify-ssr-demo))

## Примеры

Ознакомьтесь с [проектами](https://github.com/QingWei-Li/docsify/#showcase), использующие docsify.

## Donate

Пожалуйста, рассмотрите возможность сделать пожертвование, если вы считаете, что docsify полезен. Я рад, если вы можете мне помочь [купить чашку кофе](https://github.com/QingWei-Li/donate). :heart: