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

@julienne/static

v0.1.0

Published

Static site renderer for julienne

Downloads

5

Readme

@julienne/static

Static site renderer for julienne.

Usage

import { createRenderer, createDevRenderer } from 'julienne';
import { Site, write } from '@julienne/static';

let renderer = await createRenderer({
  /* ...myConfig */
});
let site = new Site();

site.createPage('/path/to/page', () => ({
  template: 'my-template',
  props: {
    /* ...myProps */
  },
}));

await write({ output: '/path/to/output', renderer, site });

API

Site

Create a new site instance.

Example usage:

let site = new Site();

Site.createPage(path, getPage)

Example usage:

site.createPage('/', () => ({
  template: 'main',
  props: {
    name: 'World',
  },
}));

path

Type: string

The path/URL to create the page at. This path must start with a forward slash.

getPage

Function that returns page configuration. This is where you specify what template to use to generate the page and the props to pass to the template. julienne will await values returned from getPage, so you can use async/await.

Template configuration has the following type:

{

  template: string;
  props: Record<string, unknown>;
}

createFile(path, getFile)

Example usage:

site.createFile('/index.json', () => JSON.stringify({ key: 'value' }));

path

The path/URL to create the file at. This path must start with a forward slash.

getFile

Function that returns file data, which can be a string, a Buffer, or a stream. julienne will await values returned from getFile, so you can use async/await.

copyFile(to, from)

Example usage:

site.copyFile("/robots.txt", path.join(__dirname, "robots.txt"));`

to

Type: string

The path/URL to copy the file to. This path must start with a forward slash.

from

Type: string

The path of the file to copy.

write(options)

Writes a site's rendered pages and files to the filesystem.

Example usage:

await write({ renderer, site });

options.renderer

The Renderer instance to use for rendering templates.

options.site

The site instance to render pages and files from.

options.output (optional)

Path to a directory to write the generated files to.

License

MIT