Arrow - Documentation generation tool for Go

Releases
1

Repo: GitHub - navid-m/arrow: Documentation generator for go

Unique features:

  • Extremely fast, can document entire go stdlib in 5 seconds
  • Searchable docs through use of the search feature per package
  • Easy static HTML generation, dark mode theme

Go has lacked anything like this, so it’s a highly useful tool.

2

What’s the difference from go doc?

3

I have mentioned this both in the readme and the OP. Simplified:

The go doc process for static HTML documentation generation is cumbersome and awkward. This simplifies it greatly considering it is stateless, performant particularly in CLI usage, and not a server like go doc.

Go doc has outdated and limited UX, this is modernized, and it is in the roadmap to be extensible and themable, unlike go doc.

Go doc lacks syntax highlighting, this will use prism for syntax highlighting.

Go doc does not have symbol search with anchors, so you can’t go to symbols/packages or search through them easily. This does.

Those are several differences.

1 Like
4

This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.