Skip to content

Commit

Permalink
Merge pull request #93 from nix-community/changelog
Browse files Browse the repository at this point in the history
Release 2.6.0
  • Loading branch information
infinisil committed Nov 18, 2023
2 parents 0d7d7ff + 7d5c03a commit 93ca893
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 2 deletions.
53 changes: 53 additions & 0 deletions CHANGELOG.md
@@ -1,5 +1,58 @@
# Changelog

## 2.6.0

- 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 https://github.com/nix-community/nixdoc/pull/70

For example, the following file
```nix
/*
This is just a test!
*/
{
/* Increments a number by one */
increment = x: x + 1;
}
```

turns into the following markdown:

```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.

## 2.5.1

- readme: fix link to rendering example by @infinisil in https://github.com/nix-community/nixdoc/pull/67
- Fix indentation of structured multi-line comments by @asymmetric in https://github.com/nix-community/nixdoc/pull/81

## 2.5.0

## 2.4.0

- Fix line indentation stripping by @infinisil in https://github.com/nix-community/nixdoc/pull/62

## 2.3.0

- nix: remove outdated outputHashes by @asymmetric in https://github.com/nix-community/nixdoc/pull/38
- add snapshot testing by @asymmetric in https://github.com/nix-community/nixdoc/pull/39
- Create dependabot.yml by @asymmetric in https://github.com/nix-community/nixdoc/pull/41
- chore(deps): bump cachix/install-nix-action from 20 to 22 by @dependabot in https://github.com/nix-community/nixdoc/pull/42
- complete the markdown transition by @pennae in https://github.com/nix-community/nixdoc/pull/40

## 2.2.0

- Update rnix to 0.11 by @pennae [#36](https://github.com/nix-community/nixdoc/pull/36)
Expand Down
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "nixdoc"
version = "2.5.0"
version = "2.6.0"
authors = ["Vincent Ambo <mail@tazj.in>", "asymmetric"]
edition = "2021"
description = "Generate CommonMark from Nix library functions"
Expand Down

0 comments on commit 93ca893

Please sign in to comment.