https://github.com/antharuu/velvet

Velvet is a HTML preprocessor, converting Velvet language (PUGjs like) to HTML.
https://github.com/antharuu/velvet

customizable fast html preprocessor pug template-engine-html typescript

Last synced: 2 months ago
JSON representation

Velvet is a HTML preprocessor, converting Velvet language (PUGjs like) to HTML.

• Host: GitHub
• URL: https://github.com/antharuu/velvet
• Owner: antharuu
• Created: 2022-09-21T21:44:26.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-03T18:43:50.000Z (9 months ago)
• Last Synced: 2024-10-12T05:13:21.150Z (3 months ago)
• Topics: customizable, fast, html, preprocessor, pug, template-engine-html, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/velvet-lang
• Size: 1.72 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        


  


  

  


  Velvet

  




A simple, fast and customizable HTML preprocessor, 

 inspired by pug.




  

  

  

  

    

  

  

  

  

  



> ⚠️ Velvet is still under development and many features of the final version are not yet present. It is possible that the syntax or the way Velvet is used will change in future versions.

## Installation

To use Velvet you just have to install it with your favorite package manager:

```bash

# NPM

$ npm install velvet-lang --save-dev

# Yarn

$ yarn add velvet-lang --dev

# PNPM

$ pnpm add velvet-lang --save-dev

```

## How To Use

```js

import Velvet from "velvet-lang";

const html = Velvet.parse("h1 Hello world");

```

## Syntaxe

> **Note**

> A website with documentation on the syntax will be released once the project is more progressed.

Simple examples

```pug

h1 Hello world

// 
Hello world


h1 Hello

  span world

// 
Hello world



h1(data-test="title") Hello world

// 
Hello world

```