emaki.lol

Docs site for Emaki, built with Quarto.

Develop

quarto preview

Deploy

Pushing to main runs .github/workflows/publish.yml, which renders the site and pushes it to the gh-pages branch. Netlify serves emaki.lol from that branch.

How it is put together

docs/design.md is the standard the site is held to: the rules, the palette and its roles, the faces, the elements and the motion. The neutrals and the faces are the app's (emaki/crates/emaki-app/themes/emaki.json, emaki/docs/look.md); the colors are the icon's. Tokens live in css/theme.scss, the dark appearance's Bootstrap knobs in css/dark.scss, and the icons in assets/icons/ are the app's own Tabler files, drawn through CSS masks. js/page.js names this computer's installer on the landing page's download and marks it among the Get Started page's tiles, and lets the landing page's bands rise into view.

js/figures.js is every figure on the site: Hairline's engine (@lucasmarkes/hairline, MIT) and Emaki's own drawn on its core (scripts/figures/emaki/). On the landing page they are the two windows under "From the IDE to the ADE", an IDE's and Emaki's with their panes named, and the six of the app's parts; in the docs, the layout on Get Started, the same window at the head of each part's page with that part in color and the rest gray, the settings' sections one by one, and the composer's close-ups on Chats. scripts/figures/build.sh builds it from Hairline's repository at a pinned tag; the output is committed, so a render needs no Node.

_hero.html is the handscroll on the landing page, a port of the app's own figure (Workbench::home_scroll). Its four landscape layers are generated by scripts/home-scroll.py in the app repo and inlined so they inherit currentColor; re-copy them rather than editing them. js/hero-scroll.js runs the spring that winds it under the pointer, with the app's own constants.

js/navbar-widgets.js puts the app's latest version in the navbar, read from its GitHub releases, adds a dark-mode toggle and a GitHub stars/forks dropdown, and opens the search on ⌘F (Ctrl+F elsewhere). It reads the owner and repo from the navbar's GitHub link, which points at the app.