Repolode
Предложить
freeCodeCamp

freeCodeCamp/devdocs

Веб-браузер API-документации: объединяет справочники для разработчиков в одном интерфейсе с поиском и офлайн-доступом.

Open source альтернатива:Dash

Открыть на GitHubСайт
Звёзды
39,565
Форки
2,655
Открытые issues
201
Последний коммит
вчера

Что это?

DevDocs объединяет справочную документацию по множеству языков программирования, фреймворков и инструментов в одном веб-интерфейсе с мгновенным поиском, сочетаниями клавиш, тёмной темой и адаптацией для мобильных устройств. Пользователи выбирают, какие наборы документации установить, поэтому приложение загружает только нужное.

Приложение целиком работает в браузере и может работать офлайн после загрузки документации. Его бэкенд — Ruby-скрейпер, который создаёт нормализованные HTML-файлы и файлы поискового индекса на основе исходных материалов, а также небольшой сервер Sinatra. Проект можно запустить с Docker или установить вручную с Ruby; CLI `thor` отвечает за загрузку, генерацию и упаковку наборов документации.

Проект сосредоточен на API и справочных материалах, а не на руководствах, и поддерживается freeCodeCamp. Участники могут добавлять новые наборы документации с помощью скрейпера и системы фильтров, описанных в документации проекта.

Ключевые возможности

  • 01Мгновенно ищет по множеству установленных наборов документации.
  • 02Работает офлайн после загрузки документации.
  • 03Поддерживает полноценную навигацию с клавиатуры и тёмную тему.
  • 04Запускается через Docker или вручную в окружении Ruby.
  • 05Включает CLI Thor для загрузки, генерации и упаковки документации.

Сценарии использования

  • Поиск справочной документации по API языков и фреймворков прямо в браузере.
  • Чтение документации офлайн в поездках или при нестабильном подключении.
  • Запуск собственного закрытого браузера документации с помощью Docker.
  • Создание и поддержка собственного набора документации для внутреннего использования.

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

  1. 1

    Запустить DevDocs локально с помощью Docker

    docker run --name devdocs -d -p 9292:9292 ghcr.io/freecodecamp/devdocs:latest

Что важно знать

  • Сейчас проект ищет сопровождающих, поэтому долгосрочная поддержка не гарантирована.
  • Для ручной установки требуются Ruby 4.0.7, libcurl, bsdtar и среда выполнения JavaScript; наборы документации нужно загружать отдельно.

Темы

#api-documentation#documentation#offline#developer-tools#ruby#pwa#app#devdocs#docs#documentation-tool

Частые вопросы

Что такое devdocs?
Веб-браузер API-документации: объединяет справочники для разработчиков в одном интерфейсе с поиском и офлайн-доступом. DevDocs объединяет справочную документацию по множеству языков программирования, фреймворков и инструментов в одном веб-интерфейсе с мгновенным поиском, сочетаниями клавиш, тёмной темой и адаптацией для мобильных устройств. Пользователи выбирают, какие наборы документации установить, поэтому приложение загружает только нужное.
devdocs можно использовать бесплатно? Какая у него лицензия?
devdocs распространяется с открытым исходным кодом под лицензией MPL-2.0. Перед использованием в коммерческих продуктах проверьте условия лицензии.
devdocs всё ещё поддерживается?
Активно поддерживается. Последний коммит в devdocs — 21 окт. 2026 г..
Для чего можно использовать devdocs?
Поиск справочной документации по API языков и фреймворков прямо в браузере. Чтение документации офлайн в поездках или при нестабильном подключении. Запуск собственного закрытого браузера документации с помощью Docker. Создание и поддержка собственного набора документации для внутреннего использования.
Как установить devdocs?
Запустить DevDocs локально с помощью Docker: docker run --name devdocs -d -p 9292:9292 ghcr.io/freecodecamp/devdocs:latest
Где скачать devdocs?
Исходный код и инструкции по установке — на GitHub: https://github.com/freeCodeCamp/devdocs

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты