Repolode
freeCodeCamp

freeCodeCamp/devdocs

여러 개발자 레퍼런스 문서를 검색 및 오프라인 사용이 가능한 하나의 웹 기반 API 문서 브라우저로 제공합니다.

대체할 수 있는 제품:Dash

스타
39,565
포크
2,655
열린 이슈
201
마지막 커밋
어제

어떤 프로젝트인가요?

DevDocs는 다양한 프로그래밍 언어, 프레임워크, 도구의 레퍼런스 문서를 하나의 웹 인터페이스로 모아 즉시 검색, 키보드 단축키, 다크 테마, 모바일 친화적인 레이아웃을 제공합니다. 사용자는 설치할 문서 세트를 선택할 수 있어 필요한 내용만 앱에 불러옵니다.

앱은 브라우저에서 완전히 실행되며 문서를 다운로드한 뒤에는 오프라인에서도 사용할 수 있습니다. 백엔드는 Ruby 스크래퍼로, 원본 사이트에서 정규화된 HTML과 검색 인덱스 파일을 생성하며 소형 Sinatra 서버도 포함합니다. Docker로 실행하거나 Ruby를 사용해 수동 설치할 수 있고, `thor` CLI로 문서 세트를 다운로드하고 생성 및 패키징할 수 있습니다.

이 프로젝트는 튜토리얼보다 API와 레퍼런스 콘텐츠에 중점을 두며, freeCodeCamp가 운영합니다. 기여자는 프로젝트 문서에 설명된 스크래퍼 및 필터 시스템을 통해 새 문서 세트를 추가할 수 있습니다.

핵심 기능

  • 01설치된 여러 문서 세트에서 즉시 검색합니다.
  • 02문서를 다운로드한 뒤에는 오프라인으로 사용할 수 있습니다.
  • 03전체 키보드 탐색과 다크 테마를 지원합니다.
  • 04Docker 또는 Ruby 수동 설정으로 실행할 수 있습니다.
  • 05문서를 다운로드하고 생성 및 패키징하는 Thor CLI를 제공합니다.

활용 사례

  • 브라우저를 벗어나지 않고 언어나 프레임워크의 API 레퍼런스를 찾아볼 때.
  • 여행 중이거나 연결이 불안정한 환경에서 오프라인으로 문서를 읽을 때.
  • Docker로 비공개 자체 호스팅 문서 브라우저를 실행할 때.
  • 내부 사용을 위한 맞춤 문서 세트를 만들거나 관리할 때.

빠른 시작

  1. 1

    Docker로 DevDocs를 로컬에서 실행하기

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

사용 전 알아둘 점

  • 현재 프로젝트에서 메인테이너를 찾고 있어 장기적인 유지 관리 여부가 불확실합니다.
  • 수동 설치에는 Ruby 4.0.7, libcurl, bsdtar, JavaScript 런타임이 필요하며, 문서 세트는 별도로 다운로드해야 합니다.

토픽

자주 묻는 질문

devdocs은(는) 무엇인가요?
여러 개발자 레퍼런스 문서를 검색 및 오프라인 사용이 가능한 하나의 웹 기반 API 문서 브라우저로 제공합니다. DevDocs는 다양한 프로그래밍 언어, 프레임워크, 도구의 레퍼런스 문서를 하나의 웹 인터페이스로 모아 즉시 검색, 키보드 단축키, 다크 테마, 모바일 친화적인 레이아웃을 제공합니다. 사용자는 설치할 문서 세트를 선택할 수 있어 필요한 내용만 앱에 불러옵니다.
devdocs은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?
devdocs은(는) MPL-2.0 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
devdocs은(는) 아직 유지보수되고 있나요?
활발히 유지보수 중. devdocs의 마지막 커밋은 2026년 10월 21일입니다.
devdocs은(는) 어디에 사용할 수 있나요?
브라우저를 벗어나지 않고 언어나 프레임워크의 API 레퍼런스를 찾아볼 때. 여행 중이거나 연결이 불안정한 환경에서 오프라인으로 문서를 읽을 때. Docker로 비공개 자체 호스팅 문서 브라우저를 실행할 때. 내부 사용을 위한 맞춤 문서 세트를 만들거나 관리할 때.
devdocs는 어떻게 설치하나요?
Docker로 DevDocs를 로컬에서 실행하기: docker run --name devdocs -d -p 9292:9292 ghcr.io/freecodecamp/devdocs:latest
devdocs은(는) 어디서 받을 수 있나요?
소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/freeCodeCamp/devdocs

요약은 프로젝트 README를 바탕으로 AI가 작성했습니다. GitHub 통계는 매일 갱신됩니다.

관련 프로젝트