docs: document source_code_link_template

jdx · Oct 27, 2024 · c408dad · c408dad
1 parent 62f07e2
commit c408dad
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/docs/spec/reference/index.md b/docs/spec/reference/index.md
@@ -22,5 +22,8 @@ long_about "longer help"
 after_long_help "after about"
 example "mycli --help"
 
+# render a link to the source code in markdown docs
+source_code_link_template "https://github.com/me/myproj/blob/main/src/cli/{{path}}.rs"
+
 include "./my_overrides.usage.kdl" # include another spec, will be merged and override existing values
 ```