https://github.com/stephenhutchings/night-owl

A simple, elegant and fast static site generator for node.js
https://github.com/stephenhutchings/night-owl

esmodules markdown nodejs pug sass static-site-generator

Last synced: 2 months ago
JSON representation

A simple, elegant and fast static site generator for node.js

• Host: GitHub
• URL: https://github.com/stephenhutchings/night-owl
• Owner: stephenhutchings
• License: mit
• Created: 2022-10-22T14:57:16.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2023-09-22T03:39:25.000Z (over 1 year ago)
• Last Synced: 2024-04-25T19:01:38.501Z (8 months ago)
• Topics: esmodules, markdown, nodejs, pug, sass, static-site-generator
• Language: JavaScript
• Homepage: https://night-owl.s-ings.com
• Size: 2.01 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Night Owl

[![Version][version badge]][package url]

[![License][licence badge]][licence url]

![Build status][test badge]

![Coverage][coverage badge]

Read the docs [here][documentation].

Night Owl is a simple, elegant and fast static site generator for node.js.

Night Owl has a long list of features --- file-based

routing, custom URLs, front-matter, tagging and collections, sorting, paginated

indexes, nested layouts, multi-page templates, custom compilers, file watching,

a local development server, live reloads, ECMAScript module imports, and more.

Support for a number of different template formats is also included. Generate

HTML pages from Markdown, Pug, Handlebars, JavaScript, JSON and YAML. Use the

built-in CSS, Sass, JavaScript and Typescript compilers to bundle files ready

for the browser.

```cli

npm install night-owl

```

Read more about [getting started].

## Is this ready to use?

Night Owl is still a work in progress. Although most features are now

implemented and the API is relatively stable, some bugs can still be expected.

Minor versions may include breaking changes before reaching a stable v1.0.0.

## Why not use another tool?

The driving purpose behind Night Owl is to provide a fast tool to develop static

sites, with a focus on the Pug templating language. Pug's minimalist syntax

comes at the cost of slow template compilation. Where some static site

generators recompile templates every time any file changes, Night Owl waits for

a specific template (or its dependencies) to change.

Night Owl also provides support for bundling client-side CSS and JavaScript

without any extra configuration. Modern tools often force you to buy in

to a complex and often unnecessary framework. Others require you to roll your

own Rollup or Webpack configuration in addition to setting up your site.

Night Owl aims to to strike the right balance between flexibility and

simplicity, providing enough to get you started without getting in the way.

[documentation]: https://night-owl.s-ings.com/

[getting started]: https://night-owl.s-ings.com/docs/intro/install/

[version badge]: https://img.shields.io/npm/v/night-owl.svg

[package url]: https://npmjs.org/package/night-owl

[licence badge]: https://img.shields.io/github/license/stephenhutchings/night-owl.svg?color=1c2335

[licence url]: https://github.com/stephenhutchings/night-owl/blob/master/LICENSE.md

[test badge]: https://github.com/stephenhutchings/night-owl/workflows/Docs/badge.svg?branch=master

[coverage badge]: https://night-owl.s-ings.com/assets/coverage.svg