Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/mr-sunset/zen/llms.txt

Use this file to discover all available pages before exploring further.

Because Zen is a plain static site with no server-side requirements, it can be hosted anywhere that serves static files. There is no database to provision, no runtime to configure, and no dependencies to install — upload the repository contents and it works.

​
Fork and deploy to GitHub Pages

The repository already includes a GitHub Actions workflow that handles deployment automatically. All you need to do is fork the repo and enable Pages in your fork’s settings.
1

Fork the repository

Go to https://github.com/mr-sunset/zen and click Fork in the top-right corner to create a copy under your own GitHub account.
2

Enable GitHub Pages

In your fork, open Settings → Pages. Under Build and deployment, set the Source to GitHub Actions.
3

Push to main

The included .github/workflows/static.yml workflow triggers on every push to the main branch (and can also be run manually via Actions → Run workflow). It checks out the repository, uploads the entire repo as a Pages artifact, and deploys it — no configuration needed.
4

Visit your instance

Once the workflow completes (usually under a minute), your Zen instance will be live at https://<your-username>.github.io/zen.
If the Actions tab shows a permissions error on first run, go to Settings → Actions → General and set Workflow permissions to “Read and write permissions”, then re-run the workflow.

​
Deploy to Netlify, Vercel, or Cloudflare Pages

All three platforms can serve Zen directly from a GitHub repository. The key settings are the same everywhere: point the publish directory at the repository root and leave the build command blank.
  1. In the Netlify dashboard click Add new site → Import an existing project.
  2. Connect your GitHub account and select your Zen fork.
  3. Set the following build settings:
SettingValue
Base directory(leave empty)
Build command(leave empty)
Publish directory.
  1. Click Deploy site. Netlify will publish the root of the repository as-is.
All three platforms automatically provision HTTPS and a CDN edge network, which is beneficial for audio delivery — OGG files can be large and a CDN reduces latency for visitors outside your host region.

​
Serve locally

Because of browser autoplay policies and CORS restrictions that apply to file:// URIs, opening index.html directly from the filesystem may prevent the audio from loading. The safest way to test your changes locally is to spin up a minimal HTTP server in the project directory. 
# Python 3 (no install required on macOS and most Linux distros)
python3 -m http.server 8080

# Node.js via npx (requires Node.js installed)
npx serve .
Then open http://localhost:8080 in your browser. Both options serve the repository root over HTTP, which satisfies the browser’s autoplay and CORS requirements.
Stop the server with Ctrl + C when you are done testing. Neither server persists beyond the current terminal session.

​
Customizing your instance

Zen’s minimal structure makes it easy to personalize without touching any logic:
  • Audio — replace assets/black-noise.ogg with any OGG audio file to swap the ambient sound. Keep the filename the same, or update the src attribute in index.html if you rename it.
  • Scenery — replace assets/group-tree.svg and assets/sand.svg with your own SVG illustrations to change the visual scene.
  • Palette — open style.css and edit the color values (backgrounds, text, and UI accents) to create a completely different mood.
After modifying style.css or script.js, remember to increment the ?v=N cache-busting query string in index.html so that returning visitors receive the updated files rather than a stale cached version. See Project Structure → Cache busting for details.

Build docs developers (and LLMs) love

Get started for freeTalk to us