Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/skerwe/generator-njk-site

A nunjucks and gulp static site Yeoman generator
https://github.com/skerwe/generator-njk-site

gulp nunjucks sass static-site yeoman-generator

Last synced: 11 days ago
JSON representation

A nunjucks and gulp static site Yeoman generator

Awesome Lists containing this project

README

        

# Nunjucks and Sass Static Site Generator

[![NPM version][npm-image]][npm-url]
[![Node.js CI](https://github.com/Skerwe/generator-njk-site/actions/workflows/node.js.yml/badge.svg)](https://github.com/Skerwe/generator-njk-site/actions/workflows/node.js.yml)
[![Coverage percentage][coveralls-image]][coveralls-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]

> Generate a static website using Gulp with Sass styling and Nunjucks templates.

## Installation

First, install [Yeoman](http://yeoman.io) and generator-njk-site using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).

```bash
npm install -g yo
npm install -g generator-njk-site
```

Then generate your new project:

```bash
yo njk-site
```

or

```bash
yo njk-site my-site-name
```

## This project was built with

* [Yeoman](http://yeoman.io/): The web's scaffolding tool
* [A Nunjucks and Gulp static site boilerplate](https://bitbucket.org/Skerwe/nunjucks-static-site-boilerplate/src/master/)

## License

This project is licensed under the MIT License -- see the [LICENSE](LICENSE) file for details

[npm-image]: https://badge.fury.io/js/generator-njk-site.svg
[npm-url]: https://npmjs.org/package/generator-njk-site
[coveralls-image]: https://coveralls.io/repos/github/Skerwe/generator-njk-site/badge.svg?branch=master
[coveralls-url]: https://coveralls.io/github/Skerwe/generator-njk-site?branch=master
[snyk-image]: https://snyk.io/test/github/Skerwe/generator-njk-site/badge.svg?targetFile=package.json
[snyk-url]: https://snyk.io/test/github/Skerwe/generator-njk-site?targetFile=package.json