neurocyte/flow-website
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add instructions on custom frontmatter

Browse source
This commit is contained in:
Igor Támara 2025-10-29 10:25:14 -05:00 • committed by CJ van den Berg
parent bea9c78e8e
commit 6b5bf768f2
Signed by: neurocyte
GPG key ID: 8EB1E1BB660E3FB9
1 changed files with 20 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -27,7 +27,7 @@ added.
1. Update the file `contrib/symbolnerdfontmonolist.txt` adding the unicode 1. Update the file `contrib/symbolnerdfontmonolist.txt` adding the unicode
2. Add the reference to assets/css/webfont.css 2. Add the reference to assets/css/webfont.css
3. Use it the same as layouts/templates/base.html navbar 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 ```python
pyftsubset contrib/fonts/nerdfonts/SymbolsNerdFontMono-Regular.ttf --unicodes-file=contrib/symbolnerdfontmonolist.txt --output-file=assets/fonts/SymbolsNerdFontMono-Regular.ttf 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 get it from https://github.com/ryanoasis/nerd-fonts/releases/download/v3.4.0/NerdFontsSymbolsOnly.zip
and update contrib to ease later needings. 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 ## Resources
* [Monospace Web Theme](https://owickstrom.github.io/the-monospace-web/)
* [Zine](https://zine-ssg.io/docs/) * [Zine](https://zine-ssg.io/docs/)
* [Flow Control Editor](https://github.com/neurocyte/flow) * [Flow Control Editor](https://github.com/neurocyte/flow)
* [NerdFonts](https://www.nerdfonts.com/cheat-sheet) * [NerdFonts](https://www.nerdfonts.com/cheat-sheet)
* [Monospace Web Theme](https://owickstrom.github.io/the-monospace-web/)