onessg (One Static Site Generator) is the Static Site Generator that does only one thing: compile your html. It won't minify your JS, concat your CSS, or optimize your images. Why? You most likely already have a favorite tool for doing that.
The Javascript pendulum has swung from restrictive, monolithic frameworks to modular, boilerplate-hindered libraries.
onessg changes that. We believe in the unix philosophy: do one thing and do it well.
We also believe in setting useful, but overridable defaults. Because of this, onessg requires no configuration files to get started.
npm i onessg
You will also need to install your favorite consolidate.js template engine.
(Examples here use ejs as the template engine, you can use any template engine supported by consolidate.js)
onessg assumes the following directory structure by default:
.
├── src/
| └── page-one.html
├── layouts/
| └── page.ejs
├── dist/
└── package.json
All HTML files can include front-matter (yml or json).
src/page-one.html:
---
title: "My first Page"
_layout: "page"
---
<!-- Your HTML -->
Notice the underscore before layout. Anything prefixed with an underscore is reserved word for onessg. All keys in the front-matter will be passed as a local to your templates.
layouts/page.ejs looks like this:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title><%= title %></title>
</head>
<body>
<%- _body -%>
</body>
</html>
Notice the local _body. This is the contents of the file (in the case of page-one.html, it is <!-- Your HTML -->).
Run:
onessg -e ejs
(Substitute ejs with the name of your template engine)
onessg will compile all html files in src/ (and subdirectories), and output them to dist/ (retaining the directory structure):
.
├── src/
| └── page-one.html
├── layouts/
| └── page.ejs
├── dist/
| └── page-one.html
└── package.json
dist/page-one.html looks like this:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>My first Page</title>
</head>
<body>
<!-- Your HTML -->
</body>
</html>
Success!!!
onessg -e ejs
Override Defaults:
onessg -e ejs -s source/ -d _output -l templates
Options:
-e, --engine Set the valid consolidate.js template engine to use when
parsing layouts [string] [required]
-s, --src Set the src directory [string] [default: "src/"]
-d, --dist Set the dist directory [string] [default: "dist/"]
-l, --layouts Set the layouts directory [string] [default: "layouts/"]
--help Show help [boolean]
Contributions welcome; please discuss before making significant changes.
Check the wiki for the roadmap.
MIT
FAQs
The Static Site Generator that does only one thing: compile your html and markdown.
The npm package onessg receives a total of 2 weekly downloads. As such, onessg popularity was classified as not popular.
We found that onessg demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.