{"id":50481936,"url":"https://github.com/takeokunn/readthezero","last_synced_at":"2026-06-01T18:02:15.253Z","repository":{"id":349269934,"uuid":"1201668347","full_name":"takeokunn/readthezero","owner":"takeokunn","description":"Modern, accessible HTML export theme for Org-mode — 15 color themes, dark mode, and WCAG 2.2 AA compliance. Successor to readtheorg, built with lightningcss.","archived":false,"fork":false,"pushed_at":"2026-05-02T12:21:56.000Z","size":70,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-02T14:21:23.533Z","etag":null,"topics":["accessibility","css","dark-mode","emacs","html","lightningcss","nix","org-mode","theme","wcag"],"latest_commit_sha":null,"homepage":"https://takeokunn.github.io/readthezero","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/takeokunn.png","metadata":{"files":{"readme":"README.org","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-05T01:46:52.000Z","updated_at":"2026-05-02T12:21:58.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/takeokunn/readthezero","commit_stats":null,"previous_names":["takeokunn/readthezero"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/takeokunn/readthezero","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takeokunn%2Freadthezero","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takeokunn%2Freadthezero/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takeokunn%2Freadthezero/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takeokunn%2Freadthezero/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/takeokunn","download_url":"https://codeload.github.com/takeokunn/readthezero/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/takeokunn%2Freadthezero/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33786917,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-01T02:00:06.963Z","response_time":115,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accessibility","css","dark-mode","emacs","html","lightningcss","nix","org-mode","theme","wcag"],"created_at":"2026-06-01T18:02:13.424Z","updated_at":"2026-06-01T18:02:15.247Z","avatar_url":"https://github.com/takeokunn.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"#+TITLE: readthezero\n#+OPTIONS: toc:t num:nil ^:nil\n\n[[https://github.com/takeokunn/readthezero/actions/workflows/ci.yml][https://github.com/takeokunn/readthezero/actions/workflows/ci.yml/badge.svg]]\n[[https://github.com/takeokunn/readthezero/blob/main/LICENSE][https://img.shields.io/badge/license-MIT-blue.svg]]\n\n*readthezero* is a modern, accessible HTML export theme for [[https://orgmode.org/][Org-mode]].\nIt is the successor to [[https://github.com/fniessen/org-html-themes][readtheorg]], rebuilt from scratch with contemporary CSS.\n\n[[https://takeokunn.github.io/readthezero][Live Demo]]\n\n* Features\n\n- *2-column layout* --- Left TOC sidebar and main content area (CSS Grid)\n- *Dark mode* --- Automatic via =prefers-color-scheme= with =light-dark()= support\n- *Multiple themes* --- 15 themes included (default, ocean, forest, nord, dracula, tokyo-night, gruvbox, solarized, arctic, autumn, cherry, contrast, lavender, peach, rose); easily extensible\n- *WCAG 2.2 AA* --- Accessible color contrast, focus indicators, and skip navigation\n- *CSS-first* --- Minimal JavaScript; layout and theming handled entirely in CSS\n- *RTL support* --- Right-to-left layout via CSS logical properties\n- *Print optimized* --- Clean print stylesheet with no sidebars or UI chrome\n- *Responsive* --- Collapses to single column on tablet and mobile\n\n* Quick Start\n\n1. Add the setup file reference to your =.org= file:\n\n   #+BEGIN_EXAMPLE\n   #+SETUPFILE: https://takeokunn.github.io/readthezero/readthezero-default.setup\n   #+END_EXAMPLE\n\n2. Export to HTML with =C-c C-e h h=.\n\n* Installation\n\n** From GitHub Pages CDN\n\nAdd to your Org file header:\n\n#+BEGIN_EXAMPLE\n#+SETUPFILE: https://takeokunn.github.io/readthezero/readthezero-default.setup\n#+END_EXAMPLE\n\nReplace =default= with any available theme name: =ocean=, =forest=, =nord=, =dracula=, =tokyo-night=, =gruvbox=, =solarized=, =arctic=, =autumn=, =cherry=, =contrast=, =lavender=, =peach=, or =rose=.\n\n** Local Build\n\nRequires [[https://nixos.org/][Nix]] with flakes enabled:\n\n#+BEGIN_SRC shell\nnix build .#default\n#+END_SRC\n\nThe output directory contains the CSS, JS, and setup files.\nCopy or symlink them and point =#+SETUPFILE= to the local =.setup= file.\n\n* Available Themes\n\n| Theme       | Description                                   |\n|-------------+-----------------------------------------------|\n| default     | Neutral palette with blue accents             |\n| ocean       | Cool blue tones inspired by deep water        |\n| forest      | Warm green tones inspired by nature           |\n| nord        | Arctic, north-bluish palette                  |\n| dracula     | Dark theme with vivid purple accents          |\n| tokyo-night | Dark theme inspired by Tokyo city at night    |\n| gruvbox     | Retro groove with warm earthy tones           |\n| solarized   | Precision colors for machines and people      |\n| arctic      | Clean cool whites and icy blues               |\n| autumn      | Warm oranges and reds of the fall season      |\n| cherry      | Soft pinks and cherry blossom tones           |\n| contrast    | High-contrast theme for maximum readability   |\n| lavender    | Soft purple and lavender tones                |\n| peach       | Warm peach and apricot palette                |\n| rose        | Elegant rose and dusty pink tones             |\n\n* Custom Themes\n\nCreate a CSS file that defines =--rtz-*= custom properties on =:root=.\nSee =src/themes/_variables.css= for the full variable schema.\n\n#+BEGIN_SRC css\n:root {\n  --rtz-primary: oklch(0.55 0.2 250);\n  --rtz-bg: light-dark(#ffffff, #0f0f0f);\n  --rtz-text: light-dark(#1a1a1a, #e5e5e5);\n  /* ... see _variables.css for all properties ... */\n}\n#+END_SRC\n\nPlace your theme file in =src/themes/= and add its name to the =themes= list in =flake.nix=.\n\n* Development\n\nEnter the development shell:\n\n#+BEGIN_SRC shell\nnix develop\n#+END_SRC\n\nBuild all themes:\n\n#+BEGIN_SRC shell\nnix build .#all\n#+END_SRC\n\nBuild a specific theme:\n\n#+BEGIN_SRC shell\nnix build .#ocean\n#+END_SRC\n\nBuild the example documentation:\n\n#+BEGIN_SRC shell\nnix build .#example\n#+END_SRC\n\nPreview the site locally:\n\n#+BEGIN_SRC shell\nnix run .#serve              # serves at http://localhost:8080\nnix run .#serve -- 3000      # use a custom port\n#+END_SRC\n\nRun all checks (build + lint + examples):\n\n#+BEGIN_SRC shell\nnix flake check\n#+END_SRC\n\nThe dev shell provides =lightningcss= and =esbuild=.\n\n* Browser Support\n\nBaseline Widely Available. Targets browsers with \u003e= 0.25% global usage via =lightningcss=.\n\n* Accessibility\n\nreadthezero targets *WCAG 2.2 AA* compliance:\n\n- Color contrast ratios meet AA thresholds in both light and dark modes\n- Focus indicators are visible on all interactive elements\n- Skip-to-content link for keyboard navigation\n- Semantic HTML structure with proper heading hierarchy\n- Reduced motion support via =prefers-reduced-motion=\n\n* License\n\nMIT. See [[file:LICENSE][LICENSE]].\n\nInspired by [[https://github.com/fniessen/org-html-themes][readtheorg]] by Fabrice Niessen.\nBuilt with [[https://lightningcss.dev/][lightningcss]].\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftakeokunn%2Freadthezero","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftakeokunn%2Freadthezero","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftakeokunn%2Freadthezero/lists"}