📦 Zensical Starter Template

This is a ready-to-use Zensical template designed for quick deployment using Github Pages or Cloudflare Workers, with built-in support for Dependabot and Dev Containers.

🛠️ Setup Instructions

🔧 GitHub

1. Click Use this template on the repository page
2. Create a new repository from the template
3. Give it a name and click Create repository

🚀 Quick Start (Dev Container)

You can run and develop this project inside a fully configured Dev Container using Visual Studio Code and Docker.

✅ Prerequisites

• Docker installed and running
• Visual Studio Code
• Dev Containers extension installed in VS Code

▶️ Launch Dev Container

1. Open this repository in VS Code
2. Then follow the instructions for your OS:
   • macOS: Press Command + Shift + P → type Dev Containers: Reopen in Container → press Enter
   • Windows: Press Ctrl + Shift + P → type Dev Containers: Reopen in Container → press Enter
3. VS Code will build the container and install all dependencies automatically

Once inside the container, you can serve the site locally:

zensical serve -a 0.0.0.0:8000

Then open http://localhost:8000 in your browser to preview.

⚡ Deploy to Cloudflare Workers (Optional)

Alternatively, deploy your site via Cloudflare Workers for more flexibility:

1. Open your Cloudflare Dashboard
2. Go to Compute → Workers & Pages
3. Click Get Started under Import a Repository
4. Connect your GitHub account (if not already)
5. Select your repository and begin setup
6. Enter a project name
7. Leave other settings as default and click Create and Deploy
8. You can customize wrangler.jsonc to your own liking.

📄 Deploy to GitHub Pages

This template includes automatic deployment to GitHub Pages using GitHub Actions. Every push to the master or main branch will automatically build and deploy your site.

🔐 Enable GitHub Pages

1. Go to your repository on GitHub
2. Navigate to Settings → Pages
3. Under Source, select GitHub Actions
4. The workflow will automatically deploy on the next push to master or main

Your site will be available at https://<username>.github.io/<repository-name>/

🔧 How It Works

The docs.yml workflow:

• Triggers on pushes to master or main branches
• Installs Zensical and builds the site
• Deploys the site directory to GitHub Pages

Feel free to customize the site content, theme, or CI workflow to match your project needs!