Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryanzim/onessg
The Static Site Generator that does only one thing: compile your html and markdown.
https://github.com/ryanzim/onessg
html javascript markdown static-site-generator template-engine
Last synced: 9 days ago
JSON representation
The Static Site Generator that does only one thing: compile your html and markdown.
- Host: GitHub
- URL: https://github.com/ryanzim/onessg
- Owner: RyanZim
- License: mit
- Created: 2016-07-26T20:37:56.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-05-02T13:20:19.000Z (over 5 years ago)
- Last Synced: 2024-10-25T08:08:19.005Z (12 days ago)
- Topics: html, javascript, markdown, static-site-generator, template-engine
- Language: JavaScript
- Homepage:
- Size: 107 KB
- Stars: 13
- Watchers: 3
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# onessg
[](https://travis-ci.org/RyanZim/onessg)
[](https://coveralls.io/github/RyanZim/onessg)
[](https://www.npmjs.com/package/onessg)
[](https://github.com/RyanZim/onessg/blob/master/LICENSE)
onessg (One Static Site Generator) is the Static Site Generator that does only one thing: compile your html and markdown. 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.
>
>-- [@ericclemmons](https://medium.com/@ericclemmons/javascript-fatigue-48d4011b6fc4#.7xcwmnave)
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.
## Contents
- [Installation](#installation)
- [Example](#example)
- [CLI Usage & Options](#cli-usage--options)
- [Contributing](#contributing)
- [License](#license)
## Installation
```bash
npm install -D onessg
```
You will also need to install the jstransformer for your favorite template engine. For example, if you use [EJS](https://github.com/mde/ejs), you would run:
```bash
npm install -D jstransformer-ejs
```
You can read more about jstransformers [here](docs/jstransformer.md).
**Note:** We recommend installing onessg as a devDependency (with the `-D` flag) and running it via an npm script. If you choose to install onessg globally, you will also need to install the jstransformer globally as well.
## Example
Assuming the following file/directory structure:
```
.
├── src/
| ├── _defaults.yaml
| └── page-one.md
├── layouts/
| └── page.ejs
├── dist/
└── package.json
```
**src/page-one.md**:
```html
---
title: "My first Page"
_layout: "page"
---
Hello World!
```
The front-matter (the part between the `---` lines) is written in YAML ([other languages](https://github.com/jonschlinkert/gray-matter#optionslang) are supported as well). All keys in the front-matter will be passed as locals to your templates.
Notice the underscore before `layout`. _Anything prefixed with an underscore is reserved word for onessg._ See the [full list of underscore keys](docs/underscore-reference.md).
---
You can set defaults for your front-matter in `_defaults.yaml` (`_defaults.json` works too!). These defaults can be overridden in your front-matter.
**src/_defaults.yaml**:
```yaml
title: "Hello World!" # This title will be used if none is specified
author: "John Smith"
```
If you place a `_defaults.yaml` file in a subdirectory in `src/`, settings there will only apply to files in that subdirectory and its child subdirectories.
---
Layouts are written in the templating language of your choice. We are using EJS here, but you can use any template engine that has a [jstransformer](docs/jstransformer.md). You can also use multiple template engines in the same project! onessg will infer the correct template engine from the file extension.
**layouts/page.ejs** looks like this:
```html
<%= title %>
<%- _body -%>
```
Notice the local `_body`. This is the local for outputing the contents of each file. For **page-one.md**, it is `Hello World!`.
---
**Run:**
```bash
onessg
```
onessg will compile all the html and markdown files in `src/` (and subdirectories), and output them to `dist/` (retaining the directory structure):
```
.
├── src/
| ├── _defaults.yaml
| └── page-one.md
├── layouts/
| └── page.ejs
├── dist/
| └── page-one.html
└── package.json
```
**dist/page-one.html** looks like this:
```html
My first Page
Hello World!
```
**Success!!!** :tada:
A few notes:
- The title (`My first Page`) comes from the front-matter.
- The author's name (`John Smith`) comes from the `_defaults.yaml` file.
For further reading, see the [Tutorial](docs/tutorial.md).
## CLI Usage & Options
```
onessg
onessg [-s ] [-d ] [-l ]
Options:
--help Show help [boolean]
--version Show version number [boolean]
-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/"]
-c, --config Set the directory that contains onessg.config.js [string]
Examples:
onessg
onessg -s posts/ -d output/ -l templates/
```
## `onessg.config.js`
To pass options to your template engine, you will need to use a config file. Read more about it [here](docs/config.md).
## Contributing
Contributions welcome; please read the [Contributing Guidelines](CONTRIBUTING.md) for more info.
Check the [Roadmap](https://github.com/RyanZim/onessg/wiki/Roadmap) to see what's on the horizon.
## License
[MIT](https://github.com/RyanZim/onessg/blob/master/LICENSE)