Skip to content

README.md

Latest commit

 

History

History
90 lines (60 loc) · 3.01 KB

README.md

File metadata and controls

90 lines (60 loc) · 3.01 KB

📟 Chrono's Cyber Chronicles

A highly customized digital garden built on Quartz v4, engineered with a distinct Cyberpunk / Hacker terminal aesthetic.

"Unlocking the future, one exploit at a time."

🚀 Features

This project pushes the boundaries of the default Quartz setup with extensive visual and interactive customizations:

🖥️ Interactive Terminal

Integrated xterm.js terminal emulator embedded directly into the landing page.

  • Commands: Typing help reveals available system commands.
  • Theme Control: Use theme set <name> to dynamically switch the site's entire color palette.
  • History: Full command history support (Up/Down arrows).

🎨 Dynamic Theme System

A robust custom theming engine built on SCSS variables, supporting instant switching between:

  • Matrix (Default Neon Green)
  • Amber (Retro Monochrome)
  • Cyan (Tron-like)
  • Red (Sith/Warning)
  • Purple (Synthwave)
  • Ocean (Deep Blue)
  • Cherry (Retro Pink)
  • Rainy (Muted Blue-Grey)

All themes support both Dark (CRT) and Light (High Contrast) modes.

📺 CRT & Visual Effects

Pure CSS implementation of retro hardware artifacts:

  • Scanlines: Subtle overlay for that authentic monitor feel.
  • Vignette: Radial dimming at the screen edges.
  • Screen Flicker: Gentle, non-intrusive animation (can be disabled).
  • ASCII Art: Custom pre-rendered text headers.

🛠️ Custom Components

  • Styled Graph View: Node/link colors sync dynamically with the active theme.
  • Hacker Sidebar: "Explorer" and "Table of Contents" restyled to look like system directories.
  • System Status Bar: Custom header bar with mock system indicators.

🧰 Tech Stack

  • Core: Quartz v4 (Preact, SSG)
  • Runtime: Bun >=1.3.9 (Node.js 22+ fallback)
  • Styling: Sass (SCSS) with extensive custom modules.
  • Scripting: TypeScript for terminal logic and component behavior.
  • Terminal: xterm.js integration.

⚡ Bun Runtime Optimizations

The build pipeline leverages Bun-specific APIs for improved performance, with automatic Node.js fallbacks:

Optimization File Benefit
Bun.escapeHTML() quartz/util/escape.ts SIMD-accelerated HTML escaping replaces the manual replaceAll chain
Bun.write() quartz/plugins/emitters/helpers.ts Fewer syscalls during the emit phase (~2,600+ files per build)
Bun.markdown quartz/util/markdown.ts Built-in Zig-based Markdown parser for simple md→HTML rendering

All optimizations use runtime detection (typeof Bun !== "undefined") so the project remains fully functional under Node.js.

💻 Usage

To run the system locally:

# Install dependencies
bun install

# Initialize the development server
bun run serve

# Build for production
bun run build

📝 Customization

Styles are primarily located in quartz/styles/custom.scss. Component logic can be found in quartz/components/.

Powered by Quartz. Hacked by Chrono.