# srcco

**Repository Path**: mirrors_sourcegraph/srcco

## Basic Information

- **Project Name**: srcco
- **Description**: Docco-like documentation generator powered by srclib
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-23
- **Last Updated**: 2026-04-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


  ____      _ __       ___        ___        ___   
 /',__\    /\`'__\    /'___\     /'___\     / __`\ 
/\__, `\   \ \ \/    /\ \__/    /\ \__/    /\ \_\ \
\/\____/    \ \_\    \ \____\   \ \____\   \ \____/
 \/___/      \/_/     \/____/    \/____/    \/___/ 
                                                       

srcco (pronounced "source-co") is a literate-programming-style
documentation generator that makes the code clickable so you can jump
to the definition of any function, type, or variable.

For more information, see:
  http://sourcegraph.github.io/srcco/srcco.go.html

Built on top of srclib (https://srclib.org).
Inspired by Docco (http://jashkenas.github.io/docco/), Groc
(http://nevir.github.io/groc/), and Gocco
(http://nikhilm.github.io/gocco/).

Installation:

  $ go get sourcegraph.com/sourcegraph/srcco

And install srclib:

  $ go get sourcegraph.com/sourcegraph/srclib/cmd/src
  # This will only pull down the Go toolchain.
  $ src toolchain install-std --skip-ruby --skip-javascript --skip-python

Then call srcco like this in the directory you want to build: 

  $ srcco .

Usage: srcco [FLAGS] DIR

  Generate documentation for the project at DIR.
  For more information, see:
          sourcegraph.github.io/srcco
    -github-pages=false: create docs in gh-pages branch
    -out="docs": The directory name for the output files
    -v=false: show verbose output

Languages currently supported:

- Go

Languages that will be supported soon:

- Python
- Ruby
- JavaScript
- Java