Releases: nix-community/nixdoc
Releases · nix-community/nixdoc
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
Full Changelog: v2.7.0...v3.0.0
v3.0.0
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 #70For 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
Full Changelog: v2.5.1...v2.6.0
v2.5.1
What's Changed
- readme: fix link to rendering example by @infinisil in #67
- Fix indentation of structured multi-line comments by @asymmetric in #81
Full Changelog: v2.4.0...v2.5.1
v2.4.0
v2.3.0
What's Changed
- nix: remove outdated outputHashes by @asymmetric in #38
- add snapshot testing by @asymmetric in #39
- Create dependabot.yml by @asymmetric in #41
- chore(deps): bump cachix/install-nix-action from 20 to 22 by @dependabot in #42
- complete the markdown transition by @pennae in #40
Full Changelog: v2.2.0...v2.3.0