aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSteven Arcangeli <stevearc@stevearc.com>2023-10-08 22:28:59 -0700
committerSteven Arcangeli <stevearc@stevearc.com>2023-10-08 22:46:19 -0700
commitca8edde0f4648da8d80f356e358ddc9e1330c883 (patch)
tree48017802b3bea0c0aba6f729cfd05c7106d9fb07 /README.md
parentb5a2da9410d56bd7bc229d0185ad427a966cac50 (diff)
doc: add additional information about some advanced topics
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index fb64030..f0bcf8e 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,7 @@ Lightweight yet powerful formatter plugin for Neovim
- [Formatters](#formatters)
- [Options](#options)
- [Recipes](#recipes)
+- [Advanced topics](#advanced-topics)
- [API](#api)
- [format(opts, callback)](#formatopts-callback)
- [list_formatters(bufnr)](#list_formattersbufnr)
@@ -162,6 +163,8 @@ To view configured and available formatters, as well as to see the log file, run
## Formatters
+You can view this list in vim with `:help conform-formatters`
+
<!-- FORMATTERS -->
- [alejandra](https://kamadorueda.com/alejandra/) - The Uncompromising Nix Code Formatter.
@@ -349,6 +352,16 @@ require("conform").formatters.my_formatter = {
<!-- /RECIPES -->
+## Advanced topics
+
+<!-- ADVANCED -->
+
+- [Minimal format diffs](doc/advanced_topics.md#minimal-format-diffs)
+- [Range formatting](doc/advanced_topics.md#range-formatting)
+- [Injected language formatting (code blocks)](doc/advanced_topics.md#injected-language-formatting-code-blocks)
+
+<!-- /ADVANCED -->
+
## API
<!-- API -->