neurocyte/flow-website
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
flow-website/README.md
Igor Támara 6b5bf768f2
Add instructions on custom frontmatter
2025-10-29 19:43:07 +01:00

1.8 KiB
Raw Blame History

Building

To build this site, you need zine

Just clone the repository

git clone https://github.com/ikks/flow-control.dev.git
cd flow-control.dev

and issue

zine

Then visit with your browser the site pointed by the previous command

Powered by Zine

Adding icons

We have trimmed the list of icons that come from Nerdfonts, to add an icon:

Browse in https://www.nerdfonts.com/cheat-sheet and look for the icon to be 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(to install the tool uv pip install fonttools) with:
pyftsubset contrib/fonts/nerdfonts/SymbolsNerdFontMono-Regular.ttf --unicodes-file=contrib/symbolnerdfontmonolist.txt  --output-file=assets/fonts/SymbolsNerdFontMono-Regular.ttf

If the icon you want to use from nerdonfts is not present in contrib/fonts/nerdfonts 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 fields are being used on the docs

githubedit (Optional)

Directs to contribute editing this documentation. Used by layout/tutorial.shtml.

  .githubedit** = "/docs/testing.md",

codepath (Optional)

Links to relevant source code on the current doc. Used by layout/tutorial.shtml.

  .codepath ="test",

Resources