docs: document rewriteInterlinks option

Jan0660 · Jul 27, 2023 · 3e6f328 · 3e6f328
1 parent fb04f8b
commit 3e6f328
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/README.md b/README.md
@@ -26,6 +26,7 @@ yamlPath: /home/jan/gen/api
   where your `docfx.json` file is. Can be overriden with the `DFMG_YAML_PATH` environment variable.
 - `indexSlug` is the slug of the index page, defaults to `/api`.
 - `typesGrouping` read below.
+- `rewriteInterlinks` set this to `true` if encountering issues with links when building the site.
 
 ### Types grouping