Skip to content

Commit

Permalink
doc: add help tag links
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaoshihou514 committed Feb 22, 2025
1 parent 61c5c06 commit 21acc0f
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Async formatting and linting utility for neovim `0.10+`.

## TLDR

[`help guard.nvim-tldr`](#tldr)

- Install with your favorite package manager

```
Expand Down Expand Up @@ -83,6 +85,8 @@ ft('c'):fmt({

## Usage

[`help guard.nvim-usage`](#usage)

Some presets can be configured via `vim.g.guard_config`

```lua
Expand Down Expand Up @@ -114,9 +118,9 @@ Here are all the `Guard` subcommands

## Further configuration

You can easily create your own configuration that's not in `guard-collection`, see [CUSTOMIZE.md](./CUSTOMIZE.md).
You can easily create your own configuration that's not in `guard-collection`, see [`help guard.nvim-creating-new-configurations`](./CUSTOMIZE.md).

For more niche use cases, [ADVANCED.md](./ADVANCED.md) demonstrates how to:
For more niche use cases, [`help guard.nvim-advanced-tips`](./ADVANCED.md) demonstrates how to:

- Write your own formatting logic using the `fn` field.
- Write your own linting logic using the `fn` field.
Expand Down

0 comments on commit 21acc0f

Please sign in to comment.