fthtml
v5.1.0
Published
An HTML preprocesser built to cut down on special characters/tags and typing. Incorporates importing other .ftHTML files, basic variables and is not whitespace specific. Includes a CLI
Downloads
15
Maintainers
davidfreerReadme
ftHTML is an HTML preprocessor created to simplify regular HTML markup and get rid of all the unnecessary typing needed for tags, selectors and special characters. The focus is on importing basic templates, utilizing limited variables and generating a more modularized project. Included is a CLI that helps make this transition easier by quickly converting ftHTML files to static resources you can upload to any server like normal.
Visit https://www.fthtml.com for more information and resources
Quickly build HTML resources without the limitations of HTML
STOP DOING THIS FOR COMMON BOOTSTRAP MARKUP:
<button type="button" class="btn btn-primary btn-sm">Primary</button>
<button type="button" class="btn btn-secondary btn-sm">Secondary</button>
<button type="button" class="btn btn-success btn-sm">Success</button>
<button type="button" class="btn btn-danger btn-sm">Danger</button>
<button type="button" class="btn btn-link btn-sm">Link</button>AND DO THIS WITH FTHTML:
//tiny templates are known as aliases
#tinytemplates
btn button(type=button .btn .btn-sm)
#end
btn(.btn-primary) "Primary"
btn(.btn-secondary) "Secondary"
btn(.btn-success) "Success"
btn(.btn-danger) "Danger"
btn(.btn-link) "Link"The above ftHTML snippet produces the same HTML as above, but in a more readable, customizable, friendly-to-use, reusable and modular manner.
Features
- if-elif-else decision tree and control flow
- for-each control flow
- Aliases
- Variables and global variable support
- Template and property binding
- Import other files natively
- Native JSON support
- Macros like
__DATE__,__NOW__,__JS_URI__ - Functions like
choose,html_encode,html_decode,random,replace,str_repeat,str_reverse,str_format,substring,tcase,trim - String interpolation
- Embedded Languagues
- Easy typing
- Selector syntax sugar - use
#for attribute ids and.for classes - In depth vscode extension support
For a more complete HTML example - Turn this:
<!DOCTYPE html>
<html>
<head>
<title>Page Title</title>
<link rel="stylesheet" href="styles.css"/>
</head>
<body>
<h1>My First Heading</h1>
<p>My first paragraph.</p>
<img src="img_typo.jpg" alt="Girl with a jacket">
<p style="color:red">I am a paragraph</p>
<ul id="myList" class="drinks" data-drinktypes="morning">
<li>Coffee</li>
<li>Tea</li>
<li>Milk</li>
</ul>
</body>
</html>Into ftHTML:
doctype "html"
html
{
head
{
title "Page Title"
link(rel=stylesheet href=styles.css)
}
body
{
h1 "My First Heading"
p "My First Paragraph"
img(src=img_typo.jpg alt="Girl with a jacket")
p (style="color:red") "I am a red paragraph"
ul (#myList .drinks data-drinktypes=morning) {
li "Coffee"
li "Tea"
li "Milk"
}
}
}You can import other ftHTML files by simply using the import keyword. That way you only have to write markup once and use it anywhere! The following demonstrates importing a footer tag:
html
{
import "header"
body
{
...
}
import "footer"
}Imported files must use ftHTML syntax.
You can dynamically generate content based on conditions or import scenarios but here is a brief example of how to use our #if-elif-else directives to dynamically load content based on a given expression:
#if @pageTitle contains "home"
h1 "Hello World"
#elif @pageTitle contains "contact"
h1 "Contact Me"
import "./contact-form"
#elif @pageTitle contains "about"
h1 "About Me"
import "./about"
#endInstalling
npm:
It is recommended to install ftHTML globally to take advantage of the CLI.
For those that don't know, installing globally allows you to use the module in any directory of your computer. This makes it easier to convert files to static resources, process tasks for IDE's and more.
npm install -g fthtml
Using
Node.js:
const ftHTML = require('fthtml');
ftHTML.renderFile('filename')
.then(html => console.log(html))
.catch(console.log);.fthtmlextn is intended to be omitted from the filename..renderFile()returns the interpreted HTML syntax- Alternatively, you can just compile text with ftHTML.compile(text) if you don't want to use a file
Additionally, you can convert .fthtml resources via command line and export them as static resources.
Roadmap can be found here