Skip to content

Clarify Tagref configuration documentation #288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stepchowfun merged 1 commit into from
Jun 19, 2026
Merged

Clarify Tagref configuration documentation #288

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@ Options:

## Configuration

The directory containing `tagref.yml` is the project root. If you want to use a config file at a specific path, pass `--config` or `-c`; Tagref will not search for another config file in that case.
Tagref can be configured by creating a `tagref.yml` file. This file also tells Tagref where the project root is, such that you can run `tagref` from anywhere in the project.

All fields are optional. An empty `tagref.yml` file is valid.
Below is an example demonstrating all the supported fields. All fields are optional, so an empty `tagref.yml` file is valid.

```yaml
tag_sigil: tag
Expand All @@ -90,9 +90,9 @@ ignore_rules:
- /target/
```

The sigils determine which directives Tagref recognizes. For example, if `tag_sigil` is set to `note`, then `[note:foo]` declares a tag.
The sigils determine the syntax of tags and references. For example, if `tag_sigil` is set to `note`, then `[note:foo]` declares a tag.

The `ignore_rules` field adds extra ignore rules, interpreted relative to the project root. These rules use the same pattern syntax as `.gitignore` files, but they only support exclusions. Rules beginning with `!` are rejected.
The `ignore_rules` field adds extra ignore rules, interpreted relative to the project root. These rules use the same pattern syntax as `.gitignore` files. Rules beginning with `!` are rejected.

## Installation instructions

Expand Down