Prerequisites

Before you begin, make sure you have the following installed:

• Node.js (v18 or higher)
• npm or yarn
• A code editor (VS Code recommended)

Installation

Get your project up and running in just a few steps:

1. Install Dependencies

npm install

2. Start Development Server

npm run dev

Your site will be available at http://localhost:8080

3. Build for Production

npm run build

The production-ready site will be generated in the _site directory.

Project Structure

Understanding the directory structure:

• src/ - All source files
• src/_includes/ - Templates, layouts, and components
• src/_data/ - Global data files (site.yaml, header.yaml, footer.yaml)
• src/blog/ - Blog post markdown files
• src/help/ - Help documentation pages
• src/styles/ - CSS files
• _site/ - Generated output (don't edit)

Check out the ARCH.md file for comprehensive architecture documentation!

Next Steps

Customize your starter by:

• Editing tailwind.config.js to customize your theme
• Creating new pages in src/ or blog posts in src/blog/
• Updating navigation links in src/_data/header.yaml
• Modifying footer content in src/_data/footer.yaml