itsscb/htmx
1
0
Fork 0
mirror of https://github.com/bigskysoftware/htmx.git synced 2026-01-20 15:46:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
htmx/www/README.md
Christian Tanul 25c2a08617
Pimp out the website for htmx 4.0 (#3499) 
flatten website directory structure and redesign UI
- move all templates from themes/htmx-theme/templates/ to www/templates/
- move all static assets from themes/htmx-theme/static/ to www/static/
- remove theme layer and update config.toml
- add tailwind css with typography plugin
- update hero section with 3D effects and subtle synthwave aesthetic
- update header with improved design and navigation
- add shortcut for search bar in header (CMD+K on macos, CTRL+K elsewhere)
- add status bar in header that displays title=... attribute on hover for any element
- update footer with improved design and navigation
- rename "examples" to "patterns" throughout site and docs
- reorganize patterns page from 7 categories to 4 (loading, interaction, display, advanced)
- add mac os9 finder-style design to patterns page with Chicago FLF font (classic OS9 window title font)
- add sidebar table of contents for /docs/, /reference/, and /htmx-4/ pages (mobile version still TODO)
- add `npm run site` script that uses npx for tailwindcss and zola-bin (no external dependencies needed)
- remove github buttons.js dependency and replace with custom buttons
- consolidate sponsor images into www/static/img/sponsors/ with logo-<company>.png|svg format
- standardize all image filenames to lowercase kebab-case
- clean up unused sponsor images from www/static/img/
- create construction_warning() shortcode for work-in-progress sections
- add reusable template components (toc, anchor links, sponsors shortcode)
- add horse easter egg when URL includes ?horse=true
- update website htmx.js to latest version
- update npm dependencie
2025-11-09 10:53:39 -07:00

715 B
Raw Permalink Blame History

Running The Website Locally

The htmx.org website is built with Zola.

Use npm run site to run the site locally.

The site will be available at http://localhost:1111

Folder Structure

  • content/ - markdown content for the site (docs, examples, essays, attributes, etc.)
  • templates/ - zola HTML templates (base, page, section layouts)
    • shortcodes/ - template components that can be used in markdown
  • static/ - static assets: images (img/), JavaScript (js/), stylesheets (css/)
  • config.toml - zola config file
  • syntax-theme.tmTheme - TextMate syntax highlighting theme for code blocks in Markdown
  • public/ - generated output (created by zola build)