Deluxe Universal Site Generator
DUSG is a static site generator that uses JavaScript instead of templating languages. It uses the file system instead of a database.
- Provides a Command Line Interface and a JavaScript API
- Reads Markdown files in a source directory
- Parses YAML in each file into the key
metadata - Parses Markdown in each file into the key
html - Includes a
pathkey for the output of each file - Includes a
rootRelativeUrlkey for each file - Includes a
statskey for each file's information - Creates an array of parsed files into the key
pageObjects - Uses a JavaScript function instead of templating languages
- Writes files to a destination directory
npm install --save-dev dusgSource files must end with the .md extension. A source file may begin with YAML which should begin and end with three hyphens (---). Markdown within the file will be parsed and turned into HTML.
---
title: An Example Source File
author: Luke Teaford
---
# Hello, World!
The metadata can contain whatever you want.A suitable template function is a callback that will receive a page object as its only argument. The page object has an html key that contains the markdown parsed as HTML, a metadata key that contains the YAML parsed as a JavaScript object, a path key that contains the output path of the file, and an array called pageObjects which contains each pageObject.
const exampleTemplate = aPageObject => {
const { html, metadata } = aPageObject
const { title, author } = metadata
return `<!DOCTYPE html>
<title>${title} - ${author}</title>
${html}`
}# Simplest usage
npx dusg --src='./your-source' --dest='./your-destination' --template='./your-template.js'
# Aliases are supported
npx dusg -s './your-source-directory' -d './your-destination-directory' -t './your-template.js'
# Show detailed documentation
npx dusg --helpconst dusg = require('dusg')
const aTemplateFunction = require('./your-template.js')
dusg({
src: './your-source-directory',
dest: './your-destination-directory',
template: aTemplateFunction
})- cleanUrls means each file will be written to a directory so
./about-me.mdwould become./about-me/index.html. This is enabled by default. - extension is the file extension to write. The default is
.html.