Skip to content

A template language to parsing beautiful .surf files

Notifications You must be signed in to change notification settings

ChristoferMendes/surfstar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🏄‍♂️ Surfstar 🏄‍♀️

surfstar

Requirements

  • Bun installed

🌊 Ride the Wave of Efficiency with Surfstar 🌊

Welcome to Surfstar, your dynamic template engine for Node.js and TypeScript. Surfstar enables you to seamlessly integrate dynamic content into your templates, making it easy to generate HTML, emails, or any text-based content with a focus on simplicity and flexibility.

Surfstar is heavily inspired by Handlebars! Please go there to take a look.

Why Surfstar?

Surfstar is designed to make templating a breeze. Just like riding the perfect wave, our template engine provides a fluid and intuitive experience. Whether you're a beginner or an experienced developer, Surfstar is here to streamline your templating process and keep your projects flowing smoothly.

Key Features 🚀

  • Simple Syntax: Surfstar uses a simple and intuitive syntax for embedding variables in your templates.
  • Modular Design: The template engine is modular, allowing you to extend and customize its functionality.

Getting Started 🌊

Ready to ride the wave?

Installation 🌐

bun install surfstar

Usage ✨

path/to/your/surf.template

Hello, {{ name }}! Welcome to Surfstar! 🌊
import { compileTemplate } from 'surfstar';

const result = compileTemplate('path/to/your/template.surf', { name: 'Surfer' });
console.log(result);
// Output: Hello, Surfer! Welcome to Surfstar! 🌊

About

A template language to parsing beautiful .surf files

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published