gy2h
v0.1.1
Published
A html templating system that simply evals mustached code while creating variables from yaml files.
Downloads
2
Maintainers
gcsbossReadme
gy2h
This is a basic templating server where you wil define YAML files to be your site URLs and these files shall load html files as templates as well as fill them with variables.
Obs.: Conditional and Repetition structures are not supported yet.
Warning: This was only tested in Windows 10.
Warning: This IS NOT production ready.
Obs.: For commands, be sure to use an elevated console (admin rights).
Prerequisites
- You MUST be running Windows 10 or Linux (untested).
- You MUST have up to date Node JS installed.
- You MUST have up to date NPM installed.
- If running Windows 10, you must run the following command:
npm install --global --production windows-build-tools. Obs.: It may fail sometimes. - If running Windows 10, you must ensure Phyton 2.7 (installed in the previous item) is in your Path.
Usage
Step 1
Create a YAML file with the name you want. I will call mine: settings.yml (this one will be used in step 5).
Step 2
In settings.yml, write the following content:
sourceDir: ./yml
templatesDir: ./html
port: 8001
sourceDirmust point to where your YAML files will be.templatesDirmust point to where your HTML files will be.- Those paths must be relative to
settings.ymlpath.portdefines where the HTTP server will be listening for requests.
Step 3
In sources' directory, create a file named .yml (that's right) with the following content:
title: My Awesome Title
description: My Cool description
content: My cool content
template: pageStep 4
In templates' directory, create a file named page.html with the following content:
<!DOCTYPE html>
<html>
<head>
<title>{{title}}</title>
<meta name="description" content="{{description}}" />
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
{{content}}
</body>
</html>Step 5
Install the server as a service with the following comands:
npm install -g gy2h
gy2h-service install my-project "/absolute/path/to/my/settings.yml"Step 6
- On Windows, start the server running:
net start gy2h-my-projecton elevated shell. - On Debian/Ubuntu, start the server running:
sudo service gy2h-my-project start.
Step 7
In your browser, get http://127.0.0.1:8001 and done!
Have Questions?
Please, if you have any questions, suggestions, doubts, etc.. Don't hesitate to open issues.
Thanks!