staticpug

The clean static HTML generator from HAML files using pug rendering the templates

• Render pug templates to html
• Read markdown files and insert them into the template
• Simple and easy structure to deal with
• Errors complitly explained

In order to use this package, you need to know about PUGjs - language reference

Table of content

• Notice
• Commands
  • npx sp-init
  • npx sp-build
• How it works
• Contribute

notice

VERY CASE SENSITIVE, this is a file-template base HTML generator and is sensitive to folder structure and and case sensitive!

• file names
• variables names
• everything

Commands

sp-init

OR sp-create. Creates a simple sample project to help you make your own website by just modifying it

• src/page/ (why src/page? because the template may contain layout and other components so the base pages goes to folder src/page)
• public/
• staticpug.config.json

sp-build

OR sp-execute. Builds the website by copying all files from public folder to destination and make HTML files from pug templates provided inside the source folder
Read options from one of staticpug.config.json, staticpug.json, staticpug.config file or at staticpug secton on package.json file | option | type | default | explain |
| :--- | :---: | :---: | :--- |
| staticFilesDirectory | array / string| "static" | the folder/folders to copy to destination/destinations , it can have subfolders |
| destinationDirectory | array / string| "dist" | the destination/destinations folders that contain the result files |
| sourceDirectory | array / string| "src" | the folder/folders that contain/contains template files , it can have subfolders |

How it works

All files in source folder and it's subfolders (default: src) will be affected.
The JSON file named after the pug file will be used to pass data to the pug file.
When a folder name after a pug file exists, the markdown files inside that folder will pass to the pug file as article.content, you can use it in your template (pug file). The JSON file named after the markdown file will be used to pass other informations (for each article). Each template folder can have an index file, a file named as polar of the folder name. (exp: class: classes, post: posts)
When no folder be found for the pug file, it will be simply converted to a HTML page.

Contribute

Please contribute, it's hard to continue alone >_<