Skip to content

Commit

Permalink
chore(website): fix broken anchors
Browse files Browse the repository at this point in the history
  • Loading branch information
orhun committed Jan 6, 2024
1 parent 2d30491 commit 34593dd
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 15 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<a href="https://git-cliff.org">Website</a>
</h4>

**git-cliff** can generate [changelog](https://en.wikipedia.org/wiki/Changelog) files from the [Git](https://git-scm.com/) history by utilizing [conventional commits](https://git-cliff.org/docs/configuration#conventional_commits) as well as regex-powered [custom parsers](https://git-cliff.org/docs/configuration#commit_parsers). The [changelog template](https://git-cliff.org/docs/category/templating) can be customized with a [configuration file](https://git-cliff.org/docs/configuration) to match the desired format.
**git-cliff** can generate [changelog](https://en.wikipedia.org/wiki/Changelog) files from the [Git](https://git-scm.com/) history by utilizing [conventional commits](https://git-cliff.org/docs/configuration/git#conventional_commits) as well as regex-powered [custom parsers](https://git-cliff.org/docs/configuration/git#commit_parsers). The [changelog template](https://git-cliff.org/docs/category/templating) can be customized with a [configuration file](https://git-cliff.org/docs/configuration) to match the desired format.

![animation](https://raw.githubusercontent.com/orhun/git-cliff/main/website/static/img/git-cliff-anim.gif)

Expand Down
10 changes: 5 additions & 5 deletions website/blog/git-cliff-0.5.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ In this post, I'm explaining the new features in the 0.5.0 release while giving

</center>

> [**git-cliff**](https://github.com/orhun/git-cliff) is a command-line tool (written in [Rust](https://www.rust-lang.org/)) that provides a highly customizable way to generate changelogs from git history. It supports using [custom regular expressions](/docs/configuration#commit_parsers) to alter changelogs which are mostly based on [conventional commits](/docs/configuration#conventional_commits). With a single [configuration file](/docs/configuration), a big variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired [template engine](/docs/category/templating). More information and examples can be found in the [GitHub repository](https://github.com/orhun/git-cliff).
> [**git-cliff**](https://github.com/orhun/git-cliff) is a command-line tool (written in [Rust](https://www.rust-lang.org/)) that provides a highly customizable way to generate changelogs from git history. It supports using [custom regular expressions](/docs/configuration/git#commit_parsers) to alter changelogs which are mostly based on [conventional commits](/docs/configuration/git#conventional_commits). With a single [configuration file](/docs/configuration), a big variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired [template engine](/docs/category/templating). More information and examples can be found in the [GitHub repository](https://github.com/orhun/git-cliff).
Today I released the new version (0.5.0) of `git-cliff`. There are a couple of major features that I believe are interesting and they can potentially help with different use cases. Must be exciting, let's have a look!

Expand Down Expand Up @@ -145,7 +145,7 @@ A new configuration file entry makes an appearance in the `[git]` section!
ignore_tags = "v.*-beta.*"
```

The simplest explanation would be: while [`skip_tags`](/docs/configuration#skip_tags) drop commits from the changelog, `ignore_tags` include ignored commits into the next tag.
The simplest explanation would be: while [`skip_tags`](/docs/configuration/git#skip_tags) drop commits from the changelog, `ignore_tags` include ignored commits into the next tag.

So for example if you have the following git history:

Expand Down Expand Up @@ -181,8 +181,8 @@ Tracking issue: [#36](https://github.com/orhun/git-cliff/issues/36)

Following values can be specified in the configuration file now (in `[git]` section):

- [`topo_order`](/docs/configuration#topo_order)
- [`sort_commits`](/docs/configuration#sort_commits)
- [`topo_order`](/docs/configuration/git#topo_order)
- [`sort_commits`](/docs/configuration/git#sort_commits)

For example:

Expand Down Expand Up @@ -212,7 +212,7 @@ commit_parsers = [
]
```

Other use cases of [`filter_unconventional`](/docs/configuration#filter_unconventional) are the following:
Other use cases of [`filter_unconventional`](/docs/configuration/git#filter_unconventional) are the following:

```toml
# allow only conventional commits (default)
Expand Down
4 changes: 2 additions & 2 deletions website/blog/git-cliff-1.2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ In this post, I'm giving a brief introduction to the new features in the 1.2.0 r

</center>

> [**git-cliff**](https://github.com/orhun/git-cliff) is a command-line tool (written in [Rust](https://www.rust-lang.org/)) that provides a highly customizable way to generate changelogs from git history. It supports using [custom regular expressions](/docs/configuration#commit_parsers) to alter changelogs which are mostly based on [conventional commits](/docs/configuration#conventional_commits). With a single [configuration file](/docs/configuration), a big variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired [template engine](/docs/category/templating). More information and examples can be found in the [GitHub repository](https://github.com/orhun/git-cliff).
> [**git-cliff**](https://github.com/orhun/git-cliff) is a command-line tool (written in [Rust](https://www.rust-lang.org/)) that provides a highly customizable way to generate changelogs from git history. It supports using [custom regular expressions](/docs/configuration/git#commit_parsers) to alter changelogs which are mostly based on [conventional commits](/docs/configuration/git#conventional_commits). With a single [configuration file](/docs/configuration), a big variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired [template engine](/docs/category/templating). More information and examples can be found in the [GitHub repository](https://github.com/orhun/git-cliff).
Today, the new version of `git-cliff` (1.2.0) is released. There are a couple of major cool features that I believe are interesting and also there were some internal library changes. Let's have a look!

Expand Down Expand Up @@ -61,7 +61,7 @@ See the [documentation](https://git-cliff.org/docs/integration/python) for more
### Better commit grouping

You can now use regex values while grouping the commits via [`commit_parsers`](https://git-cliff.org/docs/configuration#commit_parsers).
You can now use regex values while grouping the commits via [`commit_parsers`](https://git-cliff.org/docs/configuration/git#commit_parsers).

Let's say we have this commit history for example:

Expand Down
2 changes: 1 addition & 1 deletion website/blog/git-cliff-1.3.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ tags:

</center>

> [**git-cliff**](https://github.com/orhun/git-cliff) is a command-line tool (written in [Rust](https://www.rust-lang.org/)) that provides a highly customizable way to generate changelogs from git history. It supports using [custom regular expressions](/docs/configuration#commit_parsers) to alter changelogs which are mostly based on [conventional commits](/docs/configuration#conventional_commits). With a single [configuration file](/docs/configuration), a big variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired [template engine](/docs/category/templating). More information and examples can be found in the [GitHub repository](https://github.com/orhun/git-cliff).
> [**git-cliff**](https://github.com/orhun/git-cliff) is a command-line tool (written in [Rust](https://www.rust-lang.org/)) that provides a highly customizable way to generate changelogs from git history. It supports using [custom regular expressions](/docs/configuration/git#commit_parsers) to alter changelogs which are mostly based on [conventional commits](/docs/configuration/git#conventional_commits). With a single [configuration file](/docs/configuration), a big variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired [template engine](/docs/category/templating). More information and examples can be found in the [GitHub repository](https://github.com/orhun/git-cliff).
## What's new?

Expand Down
2 changes: 1 addition & 1 deletion website/blog/git-cliff-1.4.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ tags:

</center>

> [**git-cliff**](https://github.com/orhun/git-cliff) is a command-line tool (written in [Rust](https://www.rust-lang.org/)) that provides a highly customizable way to generate changelogs from git history. It supports using [custom regular expressions](/docs/configuration#commit_parsers) to alter changelogs which are mostly based on [conventional commits](/docs/configuration#conventional_commits). With a single [configuration file](/docs/configuration), a big variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired [template engine](/docs/category/templating). More information and examples can be found in the [GitHub repository](https://github.com/orhun/git-cliff).
> [**git-cliff**](https://github.com/orhun/git-cliff) is a command-line tool (written in [Rust](https://www.rust-lang.org/)) that provides a highly customizable way to generate changelogs from git history. It supports using [custom regular expressions](/docs/configuration/git#commit_parsers) to alter changelogs which are mostly based on [conventional commits](/docs/configuration/git#conventional_commits). With a single [configuration file](/docs/configuration), a big variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired [template engine](/docs/category/templating). More information and examples can be found in the [GitHub repository](https://github.com/orhun/git-cliff).
## What's new?

Expand Down
3 changes: 1 addition & 2 deletions website/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
sidebar_position: 1
---

# Getting Started

**git-cliff** can generate [changelog](https://en.wikipedia.org/wiki/Changelog) files from the [Git](https://git-scm.com/) history by utilizing [conventional commits](configuration#conventional_commits) as well as regex-powered [custom parsers](configuration#commit_parsers).
**git-cliff** can generate [changelog](https://en.wikipedia.org/wiki/Changelog) files from the [Git](https://git-scm.com/) history by utilizing [conventional commits](/docs/configuration/git#conventional_commits) as well as regex-powered [custom parsers](/docs/configuration/git#commit_parsers).

The [changelog template](category/templating) can be customized with a [configuration file](configuration) to match the desired format.

Expand Down
6 changes: 3 additions & 3 deletions website/docs/templating/context.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Context is the model that holds the required data for a template rendering. The

> conventional_commits = **true**
For a [conventional commit](/docs/configuration#conventional_commits) like this,
For a [conventional commit](/docs/configuration/git#conventional_commits) like this,

```
<type>[scope]: <description>
Expand Down Expand Up @@ -112,7 +112,7 @@ BREAKING CHANGE: this is a breaking change
If the `BREAKING CHANGE:` footer is present, the footer will also be included in
`commit.footers`.

Breaking changes will be skipped if [`protect_breaking_commits`](/docs/configuration#protect_breaking_commits) is set to `true`, even when matched by a skipping [commit_parser](/docs/configuration#commit_parsers).
Breaking changes will be skipped if [`protect_breaking_commits`](/docs/configuration/git#protect_breaking_commits) is set to `true`, even when matched by a skipping [commit_parser](/docs/configuration/git#commit_parsers).

### Committer vs Author

Expand All @@ -124,7 +124,7 @@ From [Git docs](https://git-scm.com/book/en/v2/Git-Basics-Viewing-the-Commit-His

> conventional_commits = **false**
If [`conventional_commits`](/docs/configuration#conventional_commits) is set to `false`, then some of the fields are omitted from the context or squashed into the `message` field:
If [`conventional_commits`](/docs/configuration/git#conventional_commits) is set to `false`, then some of the fields are omitted from the context or squashed into the `message` field:

```json
{
Expand Down

0 comments on commit 34593dd

Please sign in to comment.