Skip to content

About

Comprehensive AI context rules for building Harold static sites

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

5 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

Harold Cursor Kit

🎯 Comprehensive AI context rules for building Harold static sites

What is this?

This is a single .cursorrules file that teaches AI assistants (Cursor, Claude, GPT, etc.) everything they need to know about Harold - a static site generator using Markdown, Handlebars, and SCSS.

How to use

  1. Copy .cursorrules to your Harold project root

    cp .cursorrules /path/to/your-harold-project/
  2. Use AI to build your site

    • Ask: "Create a blog post about JavaScript"
    • Ask: "Add a new page with recent posts"
    • Ask: "Style the header component"
  3. AI will generate proper code with:

    • Valid front matter (layout, title, date)
    • Correct Handlebars syntax
    • Proper SCSS structure
    • Working relativePath helpers
    • Semantic HTML

What's included

The .cursorrules file contains:

  • ✅ Complete Harold project structure
  • ✅ Front matter requirements & examples
  • ✅ All Handlebars helpers with usage
  • ✅ Real code examples from templates
  • ✅ SCSS conventions and patterns
  • ✅ Common errors and solutions
  • ✅ Best practices and checklists
  • ✅ Build commands and testing

Why use this?

Without this file:

  • AI creates posts without front matter → Build fails
  • AI uses wrong date format → Build fails
  • AI hardcodes paths → Links break
  • AI forgets partials → No header/footer
  • You fix AI mistakes for 30 minutes

With this file:

  • AI creates perfect posts → Builds immediately
  • AI uses correct format → Everything works
  • AI uses relativePath → Links work everywhere
  • AI includes partials → Complete pages
  • You're productive from day 1

Real examples in .cursorrules

Based on actual code from harold-template-default:

  • Real post front matter
  • Real page layouts
  • Real Handlebars helpers
  • Real SCSS structure
  • Real partial patterns

Requirements

  • Harold project (created with create-harold-app)
  • AI assistant that supports .cursorrules (Cursor, Claude, etc.)

Quick Start

# 1. Copy to your project
cp .cursorrules /path/to/your-harold-project/

# 2. Ask AI to create content
"Create a blog post about TypeScript best practices"

# 3. Build and see it work
harold-scripts build

License

MIT

Links

About

Comprehensive AI context rules for building Harold static sites

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors