https://github.com/teamwork/godocgen

Generate self-contained HTML documentation with godoc.
https://github.com/teamwork/godocgen

go godoc

Last synced: 7 months ago
JSON representation

Generate self-contained HTML documentation with godoc.

• Host: GitHub
• URL: https://github.com/teamwork/godocgen
• Owner: Teamwork
• License: mit
• Created: 2017-09-12T18:08:09.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-02-28T08:46:16.000Z (over 2 years ago)
• Last Synced: 2025-01-09T09:49:19.594Z (9 months ago)
• Topics: go, godoc
• Language: HTML
• Homepage:
• Size: 3.68 MB
• Stars: 3
• Watchers: 52
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Build Status](https://github.com/Teamwork/godocgen/actions/workflows/build.yml/badge.svg)

`godocgen` generates self-contained HTML documentation with `godoc`.

Right now the logic is very much tied to GitHub; although it doesn't *have* to

be. It's just lazyness on my part :-)

Usage

=====

- Edit `config` and fill in your details.

- Generate an access token at https://github.com/settings/tokens (Settings ->

  Developer settings -> Personal access token).

  Only the `public_repo` scope is needed, but for accessing private repos you'll

  need the `repo` one.

  You can also use your regular GitHub password, but I wouldn't recommend it.

- Set your token with `export GITHUB_PASS=`.

- Run `godocgen`.