Интересные GitHub-проекты: DevDocs для чтения и поиска по документации
Сервис для чтения и поиска документации. DevDocs – это не руководство по программированию, так как документации загружены со сторонних ресурсов. Также инструмент не соревнуется с полнотекстовыми поисковыми системами, основа его поиска – метаданные.
DevDocs — это инструмент для чтения и поиска по документации с открытым исходным кодом.
Главные цели приложения
- Минимизировать время загрузки документации;
- Улучшить качество, скорость и выдачу по поисковому запросу;
- Сохранить пользовательский интерфейс чистым и удобочитаемым;
- Сохранить полный функционал в офлайн-режиме;
- Поддержка навигации с клавиатуры;
- Единообразная типография и дизайн во всех документах;
- Фокусировка на специфических категориях контента и индексировании минимума, полезного большинству разработчиков.
DevDocs — это не руководство по программированию. Контент приложения состоит из документов, загруженных со сторонних ресурсов. Также инструмент не соревнуется с полнотекстовыми поисковыми системами, основа его поиска — метаданные.
Быстрый старт
DevDocs состоит из двух частей: написанный на Ruby скрапер, генерирующий документацию и метаданные, и приложение на JavaScript.
Для работы DevDocs требуется версия Ruby 2.4.2, библиотека libcurl и JavaScript runtime, поддерживаемая ExecJS (для ОС X и Windows, для Linux — Node.js).
Для установки необходимо ввести команды:
И ввести в своем браузере localhost:9292.
Запуск DevDocs в Docker-контейнере:
Приложение
Поскольку DevDocs – это инструмент разработчика, требования к браузеру высокие.
Для компьютеров:
- Последняя версия Chrome, Firefox или Opera;
- Safari 8+
- IE / Edge 10+
Для мобильных устройств:
- iOS 8+
- Android 4.1+
- Windows Phone 8+
Команды
Для просмотра полного списка команд и настроек предусмотрена команда thor list
.
36 открытий38 показов