Skip to content

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

Notifications You must be signed in to change notification settings

antharuu/Velvet

Repository files navigation


Markdownify
Velvet

A simple, fast and customizable HTML preprocessor, inspired by pug.

GitHub last commit npm npm bundle size (version)

⚠️ 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:

# NPM
$ npm install velvet-lang --save-dev

# Yarn
$ yarn add velvet-lang --dev

# PNPM
$ pnpm add velvet-lang --save-dev

How To Use

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

h1 Hello world
// <h1>Hello world</h1>


h1 Hello
  span world
// <h1>Hello <span>world</span></h1>

h1(data-test="title") Hello world
// <h1 data-test="title">Hello world</h1>