/ justapi / webtui / README.md
swadhinbiswas 🎨 docs: new webtui/ β€” from-scratch terminal docs site (WebTUI, 8-bit palette, dual sidebar, nerd icons, 5 themes) Β· 8/8/2026
74e99fc
46 lines Β· 1.7 KB
Raw Download

JustAPI Docs β€” WebTUI Terminal Site

A from-scratch documentation site built on WebTUI (https://webtui.ironclad.sh)
β€” the pure-CSS library that brings Terminal UIs to the browser.

Structure

webtui/
β”œβ”€β”€ build.py            # static site generator (markdown β†’ HTML)
β”œβ”€β”€ css/                # vendored WebTUI (base, components, nf, themes)
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ main.css        # terminal design system (navbar, dual sidebar, landing)
β”‚   └── main.js         # theme switcher, tabs, bars, sidebar active states
β”œβ”€β”€ templates/
β”‚   β”œβ”€β”€ base.html       # page template (navbar + left nav + content + right TOC)
β”‚   └── landing.html    # home page (hero, stats, terminal, bars, cards)
β”œβ”€β”€ content/            # (empty β€” source markdown lives in ../docs_site/src/content/docs)
└── dist/               # generated static site (deploy this)

Build

python3 build.py        # reads ../docs_site/src/content/docs β†’ dist/

Output: static HTML with zero JS framework β€” WebTUI is pure CSS + a small
vanilla JS file for theme switching and the terminal interactions.

Design

  • 8-bit terminal palette β€” classic ANSI colors (--bit0..--bit15)
  • Themes: dark Β· light Β· catppuccin (default) Β· everforest Β· nord
    (floating switcher, bottom-right)
  • Nerd Font icons β€” Symbols Nerd Font via CDN + vendored nf.css
  • Font: JetBrains Mono + Symbols Nerd Font fallback
  • Layout: terminal title-bar navbar, left docs sidebar, content, right
    per-page TOC β€” the classic dual-sidebar docs layout, terminal-styled

Deploy

npx wrangler pages deploy dist --project-name=justapi