neurocyte/flow-website
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
flow-control.dev https://flow-control.dev
138 commits 1 branch 0 tags 80 MiB
Find a file
Igor Támara f88d957c1a style: lsp recommenations and tweaks on spaces and titles 
* Nerd trimmed symbols as fallback
* Explicit h2, h3, h4 font size
* Add space on ul to improve visual before code

LSP recommendations
* Remove one line comments
* Complete style removal on forms
* Removed miplaced rule
2025-11-03 15:50:36 +01:00
assets style: lsp recommenations and tweaks on spaces and titles 2025-11-03 15:50:36 +01:00
content Add more internal links and precisions on command arguments 2025-10-31 21:41:48 +01:00
contrib symbol: Add font symbol needed in palette 2025-11-03 15:50:36 +01:00
layouts style: Add highlight rules with vars 2025-11-03 15:50:36 +01:00
.gitignore Add summary architecture and contributing guides 2025-10-08 10:48:02 +02:00
deploy feat: add simple deploy script 2025-05-27 18:40:08 +02:00
LICENSE Added license 2024-11-09 13:05:16 -05:00
README.md Links between developer docs 2025-10-31 21:41:48 +01:00
zine.ziggy feat: Using nerd fonts symbol icons 2025-10-29 13:30:49 +01:00

README.md

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.smd",

codepath (Optional)

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

  .codepath ="test",

Resources