Skip to content

Releases: nix-community/nixdoc

v3.1.0

11 Feb 21:35
ec8f03b
Compare
Choose a tag to compare

What's Changed

What's Changed

  • flake.lock: Update by @roberth in #139

  • feat: Minimal format by @roberth in #140

    Add --anchor-prefix to remove or customize the function-library- prefix.

    A header won't be rendered when --description and --category are empty.
    This makes the generated markdown more flexible for inclusion in other documents.

New Contributors

Full Changelog: v3.0.8...v3.1.0

v3.0.8

05 Sep 14:37
c4ad7f5
Compare
Choose a tag to compare

What's Changed

What's Changed

New Contributors

  • @fgaz made their first contribution in #130

Full Changelog: v3.0.7...v3.0.8

v3.0.7

10 Jun 13:13
3712175
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: v3.0.5...v3.0.7

v3.0.5

17 May 00:46
b2630a0
Compare
Choose a tag to compare

What's Changed

  • Fixes: incompatibility with nixpkgs in 3.0.3 and 3.0.4 by @hsjobeki in #121.

Full Changelog: v3.0.4...v3.0.5

v3.0.4

15 Apr 15:12
4326dc7
Compare
Choose a tag to compare

What's Changed

  • Fixes: issue with headings ids introduced with 3.0.3 by @hsjobeki in #117.

Full Changelog: v3.0.3...v3.0.4

v3.0.3

09 Apr 18:03
ff2d5fd
Compare
Choose a tag to compare

What's Changed

  • chore(deps): do cargo update and nix flake update by @philiptaron in #110
  • Prove that switching from recursive attrsets to explicit inherit style doesn't impact documentation by @philiptaron in #111
  • fix: shift headings with commonmark AST by @hsjobeki in #115

New Contributors

Full Changelog: v3.0.2...v3.0.3

v3.0.2

12 Mar 00:20
a187d87
Compare
Choose a tag to compare

What's Changed

  • Update dependencies in #104

  • Avoid displaying arguments when a doc-comment is already in place.

    by @hsjobeki in #109.

Full Changelog: v3.0.1...v3.0.2

v3.0.1

27 Feb 18:41
Compare
Choose a tag to compare

What's Changed

New Features

  • Official Doc-Comments Support: We've introduced support for official doc-comments as defined in RFC145. This enhancement aligns nixdoc with our latest documentation standard.

Deprecated Features

  • Legacy Custom Format: The custom nixdoc format is now considered a legacy feature. We plan to phase it out in future versions to streamline documentation practices.
  • We encourage users to transition to the official doc-comment format introduced in this release.
  • For now we will continue to maintain the legacy format, but will not accept new features or enhancements for it. This decision allows for a period of transition to the new documentation practices.

See Migration guide for smooth transition

by @hsjobeki; co-authored by @mightyiam

in #91.

New Contributors

Full Changelog: v2.7.0...v3.0.0

v3.0.0

27 Feb 18:33
Compare
Choose a tag to compare

Removed due to invalid lock file. Use v3.0.1 instead

v2.7.0

13 Dec 19:05
2def30e
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: v2.6.0...v2.7.0