https://github.com/abhinav/doc2go

Your Go project's documentation, to-go.
https://github.com/abhinav/doc2go

documentation golang

Last synced: about 4 hours ago
JSON representation

Your Go project's documentation, to-go.

• Host: GitHub
• URL: https://github.com/abhinav/doc2go
• Owner: abhinav
• License: apache-2.0
• Created: 2022-12-21T17:34:27.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-01-06T13:12:42.000Z (7 days ago)
• Last Synced: 2025-01-06T17:13:57.249Z (7 days ago)
• Topics: documentation, golang
• Language: Go
• Homepage: https://abhinav.github.io/doc2go
• Size: 999 KB
• Stars: 93
• Watchers: 4
• Forks: 7
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# doc2go

![doc2go logo](docs/static/logo.png)

[![CI](https://github.com/abhinav/doc2go/actions/workflows/ci.yml/badge.svg)](https://github.com/abhinav/doc2go/actions/workflows/ci.yml)

[![codecov](https://codecov.io/gh/abhinav/doc2go/branch/main/graph/badge.svg?token=CD4YAVNVJF)](https://codecov.io/gh/abhinav/doc2go)

doc2go is a command line tool

that generates static HTML documentation from your Go code.

It is a self-hosted static alternative to

https://pkg.go.dev/ and https://godocs.io/.

Documentation for the tool is available at https://abhinav.github.io/doc2go/.

## Installation

See ,

but in short, use one of the following methods:

```bash

# Homebrew/Linuxbrew:

brew install abhinav/tap/doc2go

# ArchLinux User Repository

yay -S doc2go-bin

# Build from source

go install go.abhg.dev/doc2go@latest

```

## Getting Started

To get started with doc2go, see

.

If you just want a copy-paste-friendly setup

to publish your documentation to GitHub Pages,

see .

## License

This software is licensed under the Apache 2.0 License

with the exception of the following files.

    internal/godoc/synopsis.go

    internal/godoc/synopsis_test.go

The license for those files is noted inside them.