Skip to content

v0.16.0

Latest
Latest

Choose a tag to compare

View all tags
@rich-iannone rich-iannone released this 27 Jul 23:51
· 179 commits to main since this release
v0.16.0
393af82
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Great Docs v0.16.0 expands language support, improves build performance, and refines how docstrings are rendered. This release introduces Go CLI documentation generation, a shortcode for including source code files with automatic syntax highlighting, and significantly faster builds through caching and parallel rendering. Docstrings now support canonical directives that render as styled callouts, and the announcement banner gains a configurable position option.

New Features

  • Go CLI documentation — Go projects can now generate a complete CLI reference automatically. Great Docs detects Go projects via go.mod, builds the binary, and extracts the full command tree through --help flags, supporting Cobra, urfave/cli, and any Go CLI framework. (#263)
  • Code includes — The {{< include >}} shortcode now handles code files intelligently, auto-detecting the language and wrapping content in a syntax-highlighted code block. Supports lines for showing specific ranges and lang for overriding language detection. (#270)
  • Announcement banner positioning — The announcement banner now accepts a position option ("above-navbar" or "below-navbar") to control where it appears relative to the navigation bar. (#286)
  • Canonical docstring directives — Docstrings now support directives like %note, %warning, %tip, %deprecated, and %versionadded that automatically render as styled Quarto callouts, eliminating the need for raw markup. (#284)

Enhancements

  • Build performance is significantly improved through per-build caching of package introspection and parallel multi-version rendering with bounded worker pools. (#271, #274)
  • Event handlers are now managed through a hook registry that coordinates execution by priority, replacing hardcoded sequences and enabling cleaner extensibility. (#259)
  • %nodoc and %seealso directives are now handled during object resolution instead of post-render HTML manipulation, improving reliability and consistency. (#256, #257)
  • API reference generation is automatically skipped for non-Python projects, avoiding unnecessary prompts for a package name. (#264)
  • Authored frontmatter titles on index.qmd pages are now preserved through the build process. (#260)

Bug Fixes

  • Dark mode assets are now correctly copied to the output directory. (#269)
  • Go CLI command descriptions are no longer truncated mid-word. (#265)
  • Enum documentation now renders correctly. (#279)
  • The SKILL.md install command now uses the distribution name of the library. (#280)
  • Sidebar items are now sorted correctly. (#283)
  • Frozen JS files now consistently end with a newline. (#285)
  • A failing GDG test spec was corrected. (#278)

Documentation

  • Added documentation on macOS dynamic library registration. (#275)
Assets 2
Loading