Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Releases: abhinav/doc2go

v0.12.0

08 Dec 23:25
22fcdc1

Choose a tag to compare

Added

  • Links to documentation for third-party packages now include version references for the version of the third-party module in use. For links to https://pkg.go.dev, this is enabled without any changes. For link templates specified with -pkg-doc, new variables have been added to allow the equivalent: {{.Module.Path}}, {{.Module.Version}}, and {{.Module.Subpath}}. The new -no-mod-versions flag opts out of this functionality.
  • Add '-C DIR' flag to change to the given directory before running similarly to the -C flag offered by go and git.

v0.11.0

01 Dec 04:13
43db083

Choose a tag to compare

This release switches doc2go to using Go type analysis (via go/types)
instead of syntactic analysis (via go/ast) which was deprecated in Go 1.22.

This improves accuracy around which identifiers are rendered as links
in the generated HTML, covering many cases that were previously missed.

This has only a small negative impact on performance, as shown below:

❯ hyperfine './doc2go.old -out old std' './doc2go.new -out new std'
Benchmark 1: ./doc2go.old -out old std
  Time (mean ± σ):      2.178 s ±  0.057 s    [User: 3.010 s, System: 0.530 s]
  Range (min … max):    2.143 s …  2.332 s    10 runs

Benchmark 2: ./doc2go.new -out new std
  Time (mean ± σ):      2.324 s ±  0.110 s    [User: 3.296 s, System: 0.538 s]
  Range (min … max):    2.255 s …  2.630 s    10 runs

If you see any issues with Go source code
that was previously rendered correctly but is now incorrect,
please file an issue at https://github.com/abhinav/doc2go/issues.

v0.10.0

29 Nov 23:57
19b909f

Choose a tag to compare

Added

  • Add -rel-link-style=index option for rendering relative links with explicit index file (e.g., foo/index.html). Supports custom index basenames set with the -basename flag.

v0.9.2

29 Nov 17:42
1c0001c

Choose a tag to compare

Fixed

  • Fix panic in highlighting certain corner cases.

v0.9.1

28 Aug 02:25
e42bde7

Choose a tag to compare

Fixed

  • Fix binary from Homebrew Cask not running on macOS
    because of unsigned binary.

v0.9.0

28 Aug 02:11
55a228a

Choose a tag to compare

Added

  • Go 1.25 support.

Changed

  • Don't render types and functions in main packages. The only consumable part of these is the command itself. Subpackages will still be rendered as before.
  • Homebrew Tap now publishes Casks instead of Formulae.

v0.8.1

13 Feb 03:50
66735a7

Choose a tag to compare

Fixed

  • -rel-link-style: Don't generate trailling '/' for static assets.

v0.8.0

12 Feb 01:08
d024db8

Choose a tag to compare

Added

  • Standalone website: Include a favicon on all generated pages.
  • Standalone: Add a "Root" link to the navbar, going to the top-level page. With -subdir, this will be the sub-directory listing.
  • Add -pkg-version flag to include a version number on pages in the standalone website.
  • Add -pagefind flag to enable or disable client-side search. By default, it's enabled if pagefind is found on $PATH.

Changed

  • Standalone website: Include a link to the package index on top.

Fixed

  • Standalone: Don't show "Index" link in navbar on pages without an Index.

v0.7.0

20 Jan 04:35
4534a28

Choose a tag to compare

Added

  • Initial support for versioned documentation with -subdir. Thanks to @3052.

Fixed

  • Fix some internal packages still being listed without -internal. Thanks to @3052.
  • Don't include vendor directories.

v0.6.0

15 Nov 02:47
3397439

Choose a tag to compare

Added

  • Include example tests in generated documentation.
  • Frontmatter templates may now use .Name to handle the various title selection cases.

Changed

  • Standalone website shows deprecated elements as collapsed by default.