npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

enoki-build

v1.1.1

Published

A simple static-site generator for Enoki sites

Downloads

2

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

kodedninjakodedninja

Keywords

Readme

enoki-build

A simple static-site generator for Enoki sites.

Installation

npm i enoki-build

Usage

enoki-build was designed to require minimal configuration and to be compatible with any Enoki environment.

Three things are required:

  1. an exported Choo application using the enoki module
  2. a nanocontent structured directory
  3. an index.html file that provides the base

1. The App

For the best experience, I'd recommend using @kodedninja/enoki, instead of the official package, as this contains optimalizations for pre-rendered sites.

3. index.html

enoki-build doesn't include bundles or does any magic, but only replaces the following:

  • <!-- @content --> ― with the HTML output of the app
  • <!-- @state --> ― with a <script> setting the window.initialState
  • <!-- @title --> ― with the title of the current page

For a simple static site, don't include the @head part and do not load the bundle script.

Example HTML:

<html>
  <head>
    <title><!-- @title --></title>
    <!-- @state -->
  </head>
  <body>
    <!-- @content -->
    <script src="/bundle.js"></script>
  </body>
</html>

You can check out my personal site as an example.

CLI

usage
  enoki-build [opts] [directories to copy]
options
  --app, -a <path>        the file where the choo app's exported (./index.js)
  --content, -c <path>    content directory (./content)
  --help, -h              show this help text
  --index, -i <path>      path of the index.html (./index.html)
  --output, -o <dir>      output directory (./public)
  --sitemap <url>         generate sitemap.xml with base url
  --version, -v           print version
examples
  start build
  $ enoki-build

  start build with different content folder and index
  $ enoki-build --content ../content --index ./random/index.html

  define directories to copy to the output
  $ enoki-build assets ../bundles