v3.0.8

What's Changed

What's Changed

• fix: skip attrsets in patterns by @fgaz in #130
• feat: add json_output by @Janik-Haag in #129

New Contributors

• @fgaz made their first contribution in #130

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

v3.0.7

What's Changed

• split out and expose package recipe by @fricklerhandwerk in #125
• Allow empty prefix by @hsjobeki in #122

New Contributors

• @fricklerhandwerk made their first contribution in #125

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

v3.0.5

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

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

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

• @philiptaron made their first contribution in #110

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

v3.0.2

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

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

• @hsjobeki made their first contribution in #91

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

v3.0.0

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

v2.7.0

What's Changed

• feat: support custom prefixes by @Janik-Haag in #97

New Contributors

• @Janik-Haag made their first contribution in #97

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

v2.6.0

What's Changed

• After doing a great job of maintaining the project for this year, @asymmetric is passing on the torch to @infinisil!

• Multi-line comments at the top of the file now become the section description text.
  By @phaer in #70

  For example, the following file

  /*
  This is just a test!
  */
  {
    /* Increments a number by one */
    increment = x: x + 1;
  }

  turns into the following markdown:

  # Test {#sec-functions-library-test}
  This is just a test!
  
  ## `lib.test.increment` {#function-library-lib.test.increment}
  
  Increments a number by one
  
  `x`
  
  : Function argument

  whereas before, the top section would've been empty.

New Contributors

• @phaer made their first contribution in #70

Full Changelog: v2.5.1...v2.6.0