doctree
First-class library documentation for every language (based on tree-sitter), with symbol search & more. Lightweight single binary, run locally or self-host. Surfaces usage examples via Sourcegraph.
파일 탐색기
최종 버전 다운로드 (.zip)- ci.yml
- docker.yml
- pull_request_template.md
- add.go
- index.go
- main.go
- search.go
- serve.go
- util.go
- development.md
- operations.md
- apischema.go
- git.go
- indexer.go
- indexer.go
- indexer.go
- indexer_test.go
- indexer.go
- indexer.go
- cli.go
- indexer.go
- search.go
- schema.go
- client.go
- graphql.go
- query_def_ref_impl.go
- types.go
- android-chrome-192x192.png
- android-chrome-512x512.png
- apple-touch-icon.png
- browserconfig.xml
- favicon-16x16.png
- favicon-32x32.png
- favicon.ico
- index-cloud.html
- index.html
- mascot.svg
- mstile-150x150.png
- opendata.js
- safari-pinned-tab.svg
- site.webmanifest
- stylesheet.css
- API.elm
- APISchema.elm
- Flags.elm
- Home.elm
- Main.elm
- Markdown.elm
- Ports.elm
- Project.elm
- Route.elm
- Schema.elm
- Search.elm
- Style.elm
- Util.elm
- assets.go
- elm.json
- package-lock.json
- package.json
- sinter
- .gitattributes
- .gitignore
- .gitmodules
- .tool-versions
- Dockerfile
- go.mod
- go.sum
- LICENSE
- README.md
- renovate.json
- Taskfile.yml
# 설치 가이드
1. 코드 내려받기
git clone https://github.com/sourcegraph/doctree
깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.
cd doctree
방금 내려받은 프로젝트 폴더 안으로 이동합니다.
2. 공식 설치 스크립트
쉬움 추천사전 준비물
- APT (Debian/Ubuntu 계열) Debian/Ubuntu 계열 리눅스에 기본 내장된 패키지 매니저입니다.
apt install -y git
APT 패키지 저장소에서 바로 설치합니다 (Debian/Ubuntu 계열).
설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
3. Docker
쉬움사전 준비물
- Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
- Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
docker run -it --publish 3333:3333 --rm --name doctree --volume ~/.doctree:/home/nonroot/.doctree sourcegraph/doctree:latest
빌드된 이미지를 실제 컨테이너로 실행합니다.
docker run -it --volume $(pwd):/index --volume ~/.doctree:/home/nonroot/.doctree --entrypoint=sh sourcegraph/doctree:latest -c "cd /index && doctree index ."
빌드된 이미지를 실제 컨테이너로 실행합니다.
apt update -y && apt upgrade -y && apt install -y docker.io
이 명령어를 터미널에 그대로 입력해 실행하세요.
docker run -i --volume $(pwd):/index --volume $HOME/.doctree:/home/nonroot/.doctree --entrypoint=sh sourcegraph/doctree:latest -c "cd /index && doctree index ."
빌드된 이미지를 실제 컨테이너로 실행합니다.
docker rm -f doctree || true
이 명령어를 터미널에 그대로 입력해 실행하세요.
터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
4. Node.js
쉬움사전 준비물
cd frontend
이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.
npm install
package.json에 명시된 라이브러리들을 내려받아 설치합니다.
npm start
개발/실행 서버를 켭니다.
명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.
// repository documentation
Was this content helpful?
(0 ratings)