From 6b5bf768f2afb01959084785cb092ba7f16eab4b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Igor=20T=C3=A1mara?= <igor.tamara@gmail.com>
Date: Wed, 29 Oct 2025 10:25:14 -0500
Subject: [PATCH] Add instructions on custom frontmatter

---
 README.md | 22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 6327d4f..156377e 100644
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@ added.
 1. Update the file `contrib/symbolnerdfontmonolist.txt` adding the unicode
 2. Add the reference to assets/css/webfont.css
 3. Use it the same as layouts/templates/base.html navbar
-4. Update the fonts installing (uv pip install fonttools) with:
+4. Update the fonts(to install the tool `uv pip install fonttools`) with:
 
 ```python
 pyftsubset contrib/fonts/nerdfonts/SymbolsNerdFontMono-Regular.ttf --unicodes-file=contrib/symbolnerdfontmonolist.txt  --output-file=assets/fonts/SymbolsNerdFontMono-Regular.ttf
@@ -37,9 +37,27 @@ If the icon you want to use from nerdonfts is not present in contrib/fonts/nerdf
 get it from https://github.com/ryanoasis/nerd-fonts/releases/download/v3.4.0/NerdFontsSymbolsOnly.zip
 and update contrib to ease later needings.
 
+## Custom frontmatter
+
+Some [custom frontmatter](https://zine-ssg.io/docs/supermd/#frontmatter) fields are being used on the docs
+
+### githubedit (Optional)
+Directs to contribute editing this documentation. Used by `layout/tutorial.shtml`.
+
+```ziggy
+  .githubedit** = "/docs/testing.md",
+```
+
+### codepath (Optional)
+Links to relevant source code on the current doc. Used by `layout/tutorial.shtml`.
+
+```ziggy
+  .codepath ="test",
+```
+
 ## Resources
 
-* [Monospace Web Theme](https://owickstrom.github.io/the-monospace-web/)
 * [Zine](https://zine-ssg.io/docs/)
 * [Flow Control Editor](https://github.com/neurocyte/flow)
 * [NerdFonts](https://www.nerdfonts.com/cheat-sheet)
+* [Monospace Web Theme](https://owickstrom.github.io/the-monospace-web/)