Skip to content
This repository was archived by the owner on May 11, 2026. It is now read-only.
Merged
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ Put a `mdlinker.toml` in your project root to configure the linter.
Options are defined in [`src/config/file.rs`](src/config/file.rs) as a serde object, and can be overwritten in the cli, see `mdlinker --help` and the docstrings for full details.

```toml
# This is the folder where filenames which represent linkable words go.
pages_directory = "pages"
# These are any other files or folders you wish to scan.
files = ["journal/foo.md", "notes/**/*.md"]

# These are any other folders you wish to scan. These can't be linked to. Usually these are things which link to items in the pages_directory.
other_directories = ["journal", "notes"]
# This is the folder where new files will be created using --fix if there are any broken wikilinks.
new_files_directory = "pages"

# Exclusions
# This is how you silence specific rules or instances of errors
Expand Down
Loading