Интересные GitHub-проекты: DevDocs для чтения и поиска по документации

DevDocs — это инструмент для чтения и поиска по документации с открытым исходным кодом.

Главные цели приложения

• Минимизировать время загрузки документации;
• Улучшить качество, скорость и выдачу по поисковому запросу;
• Сохранить пользовательский интерфейс чистым и удобочитаемым;
• Сохранить полный функционал в офлайн-режиме;
• Поддержка навигации с клавиатуры;
• Единообразная типография и дизайн во всех документах;
• Фокусировка на специфических категориях контента и индексировании минимума, полезного большинству разработчиков.

DevDocs — это не руководство по программированию. Контент приложения состоит из документов, загруженных со сторонних ресурсов. Также инструмент не соревнуется с полнотекстовыми поисковыми системами, основа его поиска — метаданные.

Быстрый старт

DevDocs состоит из двух частей: написанный на Ruby скрапер, генерирующий документацию и метаданные, и приложение на JavaScript.

Для работы DevDocs требуется версия Ruby 2.4.2, библиотека libcurl и JavaScript runtime, поддерживаемая ExecJS (для ОС X и Windows, для Linux — Node.js).

Для установки необходимо ввести команды:

			git clone https://github.com/Thibaut/devdocs.git && cd devdocs
gem install bundler
bundle install
bundle exec thor docs:download --default
bundle exec rackup
		

И ввести в своем браузере localhost:9292.

Запуск DevDocs в Docker-контейнере:

			git clone https://github.com/Thibaut/devdocs.git && cd devdocs
docker build -t thibaut/devdocs .
docker run --name devdocs -d -p 9292:9292 thibaut/devdocs
		

Приложение

Поскольку DevDocs – это инструмент разработчика, требования к браузеру высокие.

Для компьютеров:

• Последняя версия Chrome, Firefox или Opera;
• Safari 8+
• IE / Edge 10+

Для мобильных устройств:

• iOS 8+
• Android 4.1+
• Windows Phone 8+

Команды

Для просмотра полного списка команд и настроек предусмотрена команда thor list.

			# Server
rackup              # Start the server (ctrl+c to stop)
rackup --help       # List server options
# Docs
thor docs:list # List available documentations
thor docs:download # Download one or more documentations
thor docs:manifest # Create the manifest file used by the app
thor docs:generate # Generate/scrape a documentation
thor docs:page # Generate/scrape a documentation page
thor docs:package # Package a documentation for use with docs:download
thor docs:clean # Delete documentation packages
# Console
thor console # Start a REPL
thor console:docs # Start a REPL in the "Docs" module
Note: tests can be run quickly from within the console using the "test" command. Run "help test"
for usage instructions.
# Tests
thor test:all # Run all tests
thor test:docs # Run "Docs" tests
thor test:app # Run "App" tests
# Assets
thor assets:compile # Compile assets (not required in development mode)
thor assets:clean # Clean old assets