Skip to content

Latest commit

 

History

History
86 lines (71 loc) · 2.92 KB

CHANGELOG.md

File metadata and controls

86 lines (71 loc) · 2.92 KB
Raw
title
Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, adheres to Semantic Versioning, and is generated by Changie.

v0.8.1 - 2024-02-12

Fixed

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

v0.8.0 - 2024-02-11

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 - 2024-01-19

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 - 2023-11-14

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.

v0.5.2 - 2023-11-10

Fixed

  • Re-release to fix partially broken release process.

v0.5.1 - 2023-11-10

Fixed

  • Fix -rel-link-style being ignored for links inside source code blocks.

v0.5.0 - 2023-08-03

Added

  • Add a -rel-link-style flag to change how relative links are rendered. Use 'directory' as an argument to add trailing slashes to relative links.

v0.4.1 - 2023-01-26

Fixed

  • Fix paths to subdirectories on Windows.

v0.4.0 - 2023-01-19

Added

  • Include a small footer on standalone pages indicating the page was generated by doc2go.
  • Add support for reading configuration from a file. Defaults to reading from doc2go.rc; can be changed with the '-config' flag.

v0.3.0 - 2023-01-18

Added

  • Added -highlight flag to control syntax highlighting.
  • Added -highlight-print-css flag to extract the CSS for a syntax highlighting theme.
  • Added -highlight-list-themes flag to list available syntax highlighting themes.

Changed

  • Code blocks in generated HTML are now syntax highlighted server-side. The default theme is richer than the prior default. Use -highlight=plain for output similar to the old behavior.

v0.2.0 - 2023-01-14

Added

  • Add '-home' flag to change the landing page of the generated website.

v0.1.1 - 2023-01-10

Fixed

  • Resolve intermittent "No non-test Go files" messages for uncompiled packages.

v0.1.0 - 2023-01-08

  • Initial release.