{"id":20825818,"url":"https://github.com/upstatement/puppy-lib","last_synced_at":"2025-05-07T20:35:17.433Z","repository":{"id":40704825,"uuid":"202723936","full_name":"Upstatement/puppy-lib","owner":"Upstatement","description":"An adorable library for building a static site generator","archived":false,"fork":false,"pushed_at":"2023-07-20T00:01:46.000Z","size":723,"stargazers_count":5,"open_issues_count":4,"forks_count":0,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-05-07T20:34:49.149Z","etag":null,"topics":["nodejs","puppeteer","static-site-generator","stream","vinyl-fs"],"latest_commit_sha":null,"homepage":"https://npmjs.com/package/@upstatement/puppy","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Upstatement.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-16T12:29:36.000Z","updated_at":"2025-02-18T23:24:45.000Z","dependencies_parsed_at":"2024-11-14T18:49:43.768Z","dependency_job_id":null,"html_url":"https://github.com/Upstatement/puppy-lib","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Upstatement%2Fpuppy-lib","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Upstatement%2Fpuppy-lib/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Upstatement%2Fpuppy-lib/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Upstatement%2Fpuppy-lib/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Upstatement","download_url":"https://codeload.github.com/Upstatement/puppy-lib/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252954108,"owners_count":21830892,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nodejs","puppeteer","static-site-generator","stream","vinyl-fs"],"created_at":"2024-11-17T23:06:52.980Z","updated_at":"2025-05-07T20:35:17.398Z","avatar_url":"https://github.com/Upstatement.png","language":"JavaScript","readme":"# Puppy Library\n\n[![Version](https://img.shields.io/npm/v/@upstatement/puppy)](https://npmjs.com/package/@upstatement/puppy)\n\n\u003e An adorable library for building static site generators\n\nLooking to build a Puppy-powered prototype? Head over to the [main Puppy repo](https://github.com/Upstatement/puppy)!\n\n## Prerequisites\n\n![Prerequisite](https://img.shields.io/badge/node-14.16.0-blue.svg)\n![Prerequisite](https://img.shields.io/badge/npm-7.11.2-blue.svg)\n\n## Install\n\n1. `nvm install`\n2. `npm install`\n\n## Usage\n\n```js\nconst puppy = require('@upstatement/puppy');\nconst stream = require('stream');\nconst twig = require('gulp-twig');\nconst util = require('util');\n\nconst html = async function () {\n  const pipeline = util.promisify(stream.pipeline);\n\n  const pages = await puppy({\n    publicPath: '/',\n    pages: 'src/pages/**/*',\n    data: 'src/data/**/*',\n  });\n  const compile = twig({\n    namespaces: { puppy: 'src/templates' },\n    useFileContents: true,\n  });\n  const dist = dest('dist');\n\n  return pipeline(pages, compile, dist);\n};\n```\n\n## 🤝Contributing\n\nContributions, issues and feature requests are welcome!\n\nFeel free to check the [issues page](https://github.com/upstatement/puppy-lib/issues).\n\n## 🚀 Release\n\nThis library is hosted on [npmjs.com](https://npmjs.com). To create a new release and publish to NPM:\n\n1. Make sure you are on the `main` branch, have pulled the latest changes from GitHub, and have no local changes:\n\n   ```shell\n   git checkout main\n   git pull\n   git status\n   ```\n\n   The last command should return the following:\n\n   ```shell\n   On branch main\n   Your branch is up to date with 'origin/main'.\n\n   nothing to commit, working tree clean\n   ```\n\n2. Bump the version according to [semantic versioning rules](https://semver.org/)\n\n   ```shell\n   npm version major|minor|patch\n   ```\n\n3. Push the commit up to the GitHub repository\n\n4. Make sure you are logged in as a user that has access to the [`@upstatement/puppy` package](https://www.npmjs.com/package/@upstatement/puppy)\n\n   ```shell\n   # Check who you are currently logged in as\n   npm whoami\n\n   # Login if you're not logged in\n   npm login\n   ```\n\n5. Publish to NPM\n\n   ```shell\n   npm publish\n   ```\n\nAfter 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.\n\n## 📝License\n\nCopyright \u0026copy; 2022 Upstatement, LLC\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fupstatement%2Fpuppy-lib","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fupstatement%2Fpuppy-lib","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fupstatement%2Fpuppy-lib/lists"}