Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/upstatement/puppy-lib
An adorable library for building a static site generator
https://github.com/upstatement/puppy-lib
nodejs puppeteer static-site-generator stream vinyl-fs
Last synced: 1 day ago
JSON representation
An adorable library for building a static site generator
- Host: GitHub
- URL: https://github.com/upstatement/puppy-lib
- Owner: Upstatement
- License: mit
- Created: 2019-08-16T12:29:36.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-07-20T00:01:46.000Z (over 1 year ago)
- Last Synced: 2024-11-14T13:51:44.082Z (5 days ago)
- Topics: nodejs, puppeteer, static-site-generator, stream, vinyl-fs
- Language: JavaScript
- Homepage: https://npmjs.com/package/@upstatement/puppy
- Size: 706 KB
- Stars: 4
- Watchers: 14
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Puppy Library
[](https://npmjs.com/package/@upstatement/puppy)
> An adorable library for building static site generators
Looking to build a Puppy-powered prototype? Head over to the [main Puppy repo](https://github.com/Upstatement/puppy)!
## Prerequisites
## Install
1. `nvm install`
2. `npm install`
## Usage
```js
const puppy = require('@upstatement/puppy');
const stream = require('stream');
const twig = require('gulp-twig');
const util = require('util');
const html = async function () {
const pipeline = util.promisify(stream.pipeline);
const pages = await puppy({
publicPath: '/',
pages: 'src/pages/**/*',
data: 'src/data/**/*',
});
const compile = twig({
namespaces: { puppy: 'src/templates' },
useFileContents: true,
});
const dist = dest('dist');
return pipeline(pages, compile, dist);
};
```
## 🤝Contributing
Contributions, issues and feature requests are welcome!
Feel free to check the [issues page](https://github.com/upstatement/puppy-lib/issues).
## 🚀 Release
This library is hosted on [npmjs.com](https://npmjs.com). To create a new release and publish to NPM:
1. Make sure you are on the `main` branch, have pulled the latest changes from GitHub, and have no local changes:
```shell
git checkout main
git pull
git status
```
The last command should return the following:
```shell
On branch main
Your branch is up to date with 'origin/main'.
nothing to commit, working tree clean
```
2. Bump the version according to [semantic versioning rules](https://semver.org/)
```shell
npm version major|minor|patch
```
3. Push the commit up to the GitHub repository
4. Make sure you are logged in as a user that has access to the [`@upstatement/puppy` package](https://www.npmjs.com/package/@upstatement/puppy)
```shell
# Check who you are currently logged in as
npm whoami
# Login if you're not logged in
npm login
```
5. Publish to NPM
```shell
npm publish
```
After the release is published, submit a PR to the [@upstatement/puppy template repo](https://github.com/Upstatement/puppy) ([example PR](https://github.com/Upstatement/puppy/pull/179)) that updates the version constraint to the new release number.
## 📝License
Copyright © 2022 Upstatement, LLC