• Stars
    star
    848
  • Rank 53,754 (Top 2 %)
  • Language
    Go
  • License
    Apache License 2.0
  • Created over 2 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

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.

doctree: 100% open-source library docs tool for every language

doctree provides first-class library documentation for every language (based on tree-sitter), with symbol search & more. If connected to Sourcegraph, it can automatically surface real-world usage examples.

Try it at doctree.org

Run locally, self-host, or use doctree.org

doctree is a single binary, lightweight, and designed to run on your local machine. It can be self-hosted, and used via doctree.org with any GitHub repository.

Experimental! Early stages!

Extremely early stages, we're working on adding more languages, polishing the experience, and adding usage examples. It's all very early and not yet ready for production use, please bear with us!

Please see the v1.0 roadmap for more, ideas welcome!

Join us on Discord

If you think what we're building is a good idea, we'd love to hear your thoughts! Discord invite

Language support

Adding support for more languages is easy. To request support for a language comment on this issue

language functions types methods consts/vars search usage examples code intel
Go
Python
Zig partial
Markdown n/a n/a n/a n/a n/a

Installation

macOS (Apple Silicon)
curl -L https://github.com/sourcegraph/doctree/releases/latest/download/doctree-aarch64-macos -o /usr/local/bin/doctree
chmod +x /usr/local/bin/doctree
macOS (Intel)
curl -L https://github.com/sourcegraph/doctree/releases/latest/download/doctree-x86_64-macos -o /usr/local/bin/doctree
chmod +x /usr/local/bin/doctree
Linux (x86_64)
curl -L https://github.com/sourcegraph/doctree/releases/latest/download/doctree-x86_64-linux -o /usr/local/bin/doctree
chmod +x /usr/local/bin/doctree
Windows (x86_64) In an administrator PowerShell, run:
New-Item -ItemType Directory 'C:\Program Files\Sourcegraph'

Invoke-WebRequest https://github.com/sourcegraph/doctree/releases/latest/download/doctree-x86_64-windows.exe -OutFile 'C:\Program Files\Sourcegraph\doctree.exe'

[Environment]::SetEnvironmentVariable('Path', [Environment]::GetEnvironmentVariable('Path', [EnvironmentVariableTarget]::Machine) + ';C:\Program Files\Sourcegraph', [EnvironmentVariableTarget]::Machine)
$env:Path += ';C:\Program Files\Sourcegraph'

Or download the exe file and install it wherever you like.

Via Docker
docker run -it --publish 3333:3333 --rm --name doctree --volume ~/.doctree:/home/nonroot/.doctree sourcegraph/doctree:latest

In a folder with Go code you'd like to see docs for, index it (for a large project like golang/go expect it to take ~52s for now. It's not multi-threaded.):

docker run -it --volume $(pwd):/index --volume ~/.doctree:/home/nonroot/.doctree --entrypoint=sh sourcegraph/doctree:latest -c "cd /index && doctree index ."
DigitalOcean user data
#!/bin/bash

apt update -y && apt upgrade -y && apt install -y docker.io
apt install -y git

mkdir -p $HOME/.doctree && chown 10000:10001 -R $HOME/.doctree

# Index golang/go repository
git clone https://github.com/golang/go
chown 10000:10001 -R go
cd go
docker run -i --volume $(pwd):/index --volume $HOME/.doctree:/home/nonroot/.doctree --entrypoint=sh sourcegraph/doctree:latest -c "cd /index && doctree index ."

# Run server
docker rm -f doctree || true
docker run -d --rm --name doctree -p 80:3333 --volume $HOME/.doctree:/home/nonroot/.doctree sourcegraph/doctree:latest

Usage

Run the server:

doctree serve

Index a Go project (takes ~52s for a large project like golang/go itself, will be improved soon):

doctree index .

Navigate to http://localhost:3333

Contributing

We'd love any contributions!

To get started see docs/development.md and the language support tracking issue.

Changelog

v0.2 (not yet released)

  • Page downloads are now even slimmer (a few KiB for a a large Go package page.)
  • Fixed an issue where root Go project pages (e.g. github.com/gorilla/mux which contains only one Go package) would not render.

v0.1

  • Go, Python, Zig, and Markdown basic support
  • Basic search navigation experience based on experimental Sinter search filters
  • Searching globally across all projects, and within specific projects is now possible.
  • Searching within a specific language is now supported (add "go", "python", "md" / "markdown" to front of your query string.)
  • Markdown files now have headers and sub-headers indexed for search (e.g. # About doctree > Installation shows up in search)
  • Basic Markdown frontmatter support.
  • Initial doctree schema format
  • Experimental (not yet ready for use) auto-indexing, doctree add . to monitor a project for file changes and re-index automatically.
  • Docker images, single-binary downloads for every OS cross-compiled via Zig compiler.
  • Initial v1.0 roadmap, language support tracking issue

Special thanks: @KShivendu (Python support), @slimsag (Zig support)

More Repositories

1

sourcegraph

Code AI platform with Code Search & Cody
Go
9,777
star
2

conc

Better structured concurrency for go
Go
6,764
star
3

checkup

Distributed, lock-free, self-hosted health checks and status pages
Go
3,392
star
4

cody

Type less, code more: Cody is an AI code assistant that uses advanced search and codebase context to help you write and fix code.
TypeScript
2,348
star
5

thyme

Automatically track which applications you use and for how long.
Go
2,237
star
6

appdash

Application tracing system for Go, based on Google's Dapper.
Go
1,720
star
7

webloop

WebLoop: Scriptable, headless WebKit with a Go API. Like PhantomJS, but for Go.
Go
1,357
star
8

go-langserver

Go language server to add Go support to editors and other tools that use the Language Server Protocol (LSP)
Go
1,163
star
9

srclib

srclib is a polyglot code analysis library, built for hackability. It consists of language analysis toolchains (currently for Go and Java, with Python, JavaScript, and Ruby in beta) with a common output format, and a CLI tool for running the analysis.
Go
944
star
10

javascript-typescript-langserver

JavaScript and TypeScript code intelligence through the Language Server Protocol
TypeScript
792
star
11

sg.nvim

Experimental Sourcegraph + Cody plugin for Neovim
Lua
707
star
12

go-diff

Unified diff parser and printer for Go
Go
407
star
13

thesrc

Example of a 3-layer (frontend, API, datastore) Go web app (based on the code that powers https://sourcegraph.com)
Go
396
star
14

go-selenium

Selenium WebDriver client for Go
Go
364
star
15

go-webkit2

WebKit API bindings (WebKitGTK+ v2) for Go
Go
305
star
16

syntaxhighlight

Go package for syntax highlighting of code
Go
263
star
17

src-cli

Sourcegraph CLI
Go
261
star
18

scip

SCIP Code Intelligence Protocol
Go
257
star
19

zoekt

Fast trigram based code search
Go
229
star
20

prototools

documentation generator & other tools for protobuf/gRPC
Go
162
star
21

jsonrpc2

Package jsonrpc2 provides a client and server implementation of JSON-RPC 2.0 (http://www.jsonrpc.org/specification)
Go
159
star
22

awesome-code-ai

A list of AI coding tools (assistants, completions, refactoring, etc.)
157
star
23

careers

Want to work at Sourcegraph?
132
star
24

openctx

See contextual info about code from your dev tools, in your editor, code review, and anywhere else you read code.
TypeScript
122
star
25

lsif-go

Language Server Indexing Format (LSIF) generator for Go
Go
111
star
26

deploy-sourcegraph

Deploy Sourcegraph to a Kubernetes cluster for large-scale code search and intelligence
Shell
104
star
27

python-langserver

Language server which talks LSP via JSONRPC for Python.
Python
102
star
28

emacs-lsp

LSP support for Emacs
Emacs Lisp
102
star
29

apiproxy

apiproxy proxies HTTP/REST APIs with configurable cache timeouts, etc.
Go
96
star
30

syntect_server

HTTP code syntax highlighting server written in Rust.
Rust
89
star
31

handbook

📘 The Sourcegraph handbook
TypeScript
87
star
32

llmsp

LLM-power language server protocol implementation.
Go
85
star
33

about

Sourcegraph blog, feature announcements, and website (about.sourcegraph.com)
TypeScript
84
star
34

sourcegraph-vscode-DEPRECATED

*️⃣+ 🆚 = ❤️
TypeScript
83
star
35

go-vcs

manipulate and inspect VCS repositories in Go
Go
77
star
36

deploy-sourcegraph-docker

Sourcegraph with Docker Compose deployment reference
Shell
73
star
37

go-lsp

Go types for the messages used in the Language Server Protocol.
Go
71
star
38

scip-java

SCIP Code Intelligence Protocol (LSIF) generator for Java
Java
60
star
39

docsite

The documentation site used by Sourcegraph
Go
57
star
40

codenotify

Go
55
star
41

codeintellify

Adds code intelligence to code views on the web ✨
TypeScript
55
star
42

jetbrains

Kotlin
54
star
43

browser-extensions

Sourcegraph's browser extensions: MOVED. See https://docs.sourcegraph.com/integration/browser_extension.
TypeScript
49
star
44

go-ses

Amazon AWS Simple Email Service (SES) client for Go
Go
49
star
45

emacs-cody

Sourcegraph Cody in Emacs
Emacs Lisp
48
star
46

sourcegraph-extension-api

Sourcegraph extension API: use and build extensions that enhance reading and reviewing code in your existing tools. "The extension API you wish your code host had."
TypeScript
44
star
47

srclib-cpp

43
star
48

go-sourcegraph

Go
43
star
49

scip-typescript

SCIP indexer for TypeScript and JavaScript
TypeScript
43
star
50

go-template-lint

Linter for Go text/template (and html/template) template files
Go
40
star
51

android-sdk-jars

HTML
40
star
52

run

🏃‍♂️ A new way to execute commands and manipulate command output in Go
Go
40
star
53

codesearch.ai

codesearch.ai semantic code search engine
Go
36
star
54

sourcegraph-jetbrains

Sourcegraph for JetBrains IDEs (IntelliJ)
Java
36
star
55

docs

Web app and content for the new Sourcegraph documentation.
TypeScript
35
star
56

lsif-node

Language Server Indexing Format (LSIF) generator for JavaScript and TypeScript
TypeScript
35
star
57

sourcegraph-typescript

Provides code intelligence for TypeScript
TypeScript
34
star
58

lsif-py

Language Server Indexing Format (LSIF) generator for Python
Python
31
star
59

srclib-c

Makefile
30
star
60

srclib-go

Go toolchain for srclib
Go
29
star
61

lsp-adapter

lsp-adapter provides a proxy which adapts Sourcegraph LSP requests to vanilla LSP requests
Go
29
star
62

s3cache

Amazon S3 storage interface for a Go cache
Go
29
star
63

srclib-python

Python
28
star
64

pydep

a simple command line tool / package that prints the dependencies of a python project
Python
28
star
65

app

Issue tracker for the Sourcegraph app - a lightweight single-binary version of Sourcegraph for your local machine
27
star
66

sg

sg releases
27
star
67

helix-docker

Docker images for Perforce Helix
Dockerfile
27
star
68

code-intel-extensions

Provides precise code intelligence via LSIF and Language Servers, and fuzzy code intelligence using ctags and text search
TypeScript
26
star
69

scip-clang

C++
25
star
70

makex

makex is a "make" clone for Go that makes it easier to write build tools in Go. It lets you define tasks and dependencies in the familiar Makefile format, and unlike just shelling out to "make", it gives you programmatic access (in Go) to the progress and console output of your tasks.
Go
24
star
71

scip-python

SCIP indexer for Python
Python
23
star
72

codemod

A collection of codemods powered by TS-Morph and PostCSS
TypeScript
23
star
73

jsonx

Extended JSON parser and writer for Go
Go
21
star
74

srclib-csharp

placeholder for a srclib C# toolchain
C#
20
star
75

learn

Sourcegraph Learn: an educational hub to support all developers
TypeScript
19
star
76

lsif-jsonnet

Language Server Index Format (LSIF) generator for JSonnet
Go
19
star
77

vcsstore

vcsstore stores VCS repositories and makes them accessible via HTTP
Go
19
star
78

sourcegraph-sublime

Sourcegraph for Sublime Text 3
Python
18
star
79

sourcegraph-git-extras

A Sourcegraph extension that adds Git blame and other useful features to code views on Sourcegraph, GitHub, GitLab, etc.
TypeScript
18
star
80

xconf

xconf.io is a config file search engine built on the Sourcegraph (https://sourcegraph.com) API. It currently supports Dockerfiles.
Go
18
star
81

go-jsonschema

EXPERIMENTAL: A Go library for working with JSON Schema (draft-07): parsing schemas, generating Go types from a JSON Schema
Go
17
star
82

themes

Color themes for Sourcegraph and editors
Shell
17
star
83

talks

Talks given about Sourcegraph or by Sourcegraphers
Go
17
star
84

phabricator-extension

Get code intelligence on Phabricator
PHP
16
star
85

httpfstream

httpstream provides HTTP handlers for simultaneous streaming uploads and downloads of objects, as well as persistence and a standalone server.
Go
16
star
86

batch-change-examples

A collection of examples for Batch Changes
Python
16
star
87

sourcegraph-alfred

Sourcegraph workflow for Alfred
Python
15
star
88

gen-mocks

Go
14
star
89

sbt-sourcegraph

sbt plugin to upload LSIF indexes to Sourcegraph for precise code intelligence
Scala
13
star
90

go-vcsurl

Lenient VCS repository URL parsing library for Go
Go
13
star
91

srclib-javascript

JavaScript (node.js) toolchain for srclib
JavaScript
12
star
92

appmon

Appmon tracks API calls in Web applications that use Go.
Go
12
star
93

srclib-php

PHP toolchain for srclib (https://srclib.org) - WORK IN PROGRESS
PHP
12
star
94

yj

Convert YAML to JSON
Go
12
star
95

go-papertrail

Go API client for papertrail (https://papertrailapp.com), a hosted log management service.
Go
12
star
96

log

OpenTelemetry-compatible Zap logger for Sourcegraph
Go
11
star
97

scip-go

SCIP indexer for Golang
Go
11
star
98

annotate

Go package for applying multiple sets of annotations to a region of text
Go
11
star
99

codesearchguide.org

Everything you ever wanted to know about code search. (WIP, will be online soon!)
CSS
11
star
100

multicache

Package multicache provides a "fallback" cache implementation that short-circuits gets and writes/deletes to all underlying caches.
Go
11
star