ouais

0.3.0 • Public • Published

Ouais Static Site Generator

Templating languages? No, ouais.

Design Goals

  1. [x] Write markdown and YAML to HTML
  2. [x] Use template functions (not templating languages)
  3. [x] Support clean URLs

Install

npm install ouais

Usage

ouais --s 'src/md' --d 'build' --t 'your-template.js'

API

--s, --src Directory to read from (defaults to src/md)
--d, --dest Directory to write to (defaults to build)
--t, --template Template to apply
--c, --clean-urls Option to use clean URLs (defaults to true). Use 'false' to disable.

Example Markdown File

---
title: 'Whatever'
---
Lorem ipsum.

Example Template Function

// your-template.js
const yourTemplate = (html, metadata) => {
  const { title } = metadata
  return `<!DOCTYPE html>
<title>${title}</title>
<main>
  <h1>${title}</h1>
  ${html}
</main>
`
}

module.exports = yourTemplate

Package Sidebar

Install

npm i ouais

Weekly Downloads

2

Version

0.3.0

License

GPL-3.0-or-later

Unpacked Size

46.1 kB

Total Files

20

Last publish

Collaborators

  • luketeaford