{"id":18434687,"url":"https://github.com/assemble/assemble-permalinks","last_synced_at":"2025-04-07T19:31:52.482Z","repository":{"id":57185019,"uuid":"42791127","full_name":"assemble/assemble-permalinks","owner":"assemble","description":"Permalinks plugin for assemble (0.6+)","archived":false,"fork":false,"pushed_at":"2017-06-17T19:23:07.000Z","size":37,"stargazers_count":5,"open_issues_count":4,"forks_count":2,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-10-16T07:05:28.668Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/assemble.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}},"created_at":"2015-09-19T21:59:05.000Z","updated_at":"2017-12-30T16:12:32.000Z","dependencies_parsed_at":"2022-09-14T10:11:02.177Z","dependency_job_id":null,"html_url":"https://github.com/assemble/assemble-permalinks","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assemble%2Fassemble-permalinks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assemble%2Fassemble-permalinks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assemble%2Fassemble-permalinks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/assemble%2Fassemble-permalinks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/assemble","download_url":"https://codeload.github.com/assemble/assemble-permalinks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247249524,"owners_count":20908212,"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":[],"created_at":"2024-11-06T06:04:54.848Z","updated_at":"2025-04-07T19:31:52.116Z","avatar_url":"https://github.com/assemble.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# assemble-permalinks [![NPM version](https://img.shields.io/npm/v/assemble-permalinks.svg?style=flat)](https://www.npmjs.com/package/assemble-permalinks) [![NPM monthly downloads](https://img.shields.io/npm/dm/assemble-permalinks.svg?style=flat)](https://npmjs.org/package/assemble-permalinks)  [![NPM total downloads](https://img.shields.io/npm/dt/assemble-permalinks.svg?style=flat)](https://npmjs.org/package/assemble-permalinks) [![Linux Build Status](https://img.shields.io/travis/assemble/assemble-permalinks.svg?style=flat\u0026label=Travis)](https://travis-ci.org/assemble/assemble-permalinks) [![Windows Build Status](https://img.shields.io/appveyor/ci/assemble/assemble-permalinks.svg?style=flat\u0026label=AppVeyor)](https://ci.appveyor.com/project/assemble/assemble-permalinks)\n\n\u003e Assemble plugin for easily creating permalinks (Assemble ^0.6.0)\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save assemble-permalinks\n```\n\nInstall with [yarn](https://yarnpkg.com):\n\n```sh\n$ yarn add assemble-permalinks\n```\n\n**HEADS UPS**\n\n* 0.5.0 has a breaking change. It will no longer immediately run the permalink when used on a view directly.\n\n## Usage\n\n```js\nvar permalinks = require('assemble-permalinks');\nvar assemble = require('assemble');\n\nvar app = assemble();\n\n// register the plugin, optionally passing a\n// default permalink pattern to use as an argument\n// to the plugin\napp.use(permalinks());\n```\n\n**Example usage**\n\n```js\n// create a view collection\napp.create('pages');\n\n// add a page\napp.page('a/b/c.txt', {content: '...'})\n  .permalink(':name.html');\n\nvar page = app.pages.getView('a/b/c.txt');\nconsole.log(page.data.permalink);\n//=\u003e 'c.html'\n```\n\n**Pipeline plugin**\n\n```js\nvar posts = app.create('posts')\n  .use(permalink('actual/:name/index.html'));\n\napp.task('site', function() {\n  return posts.src('*.js')\n    .pipe(posts.permalink())\n    .pipe(posts.dest('.'));\n});\n\napp.build('site', function(err) {\n  if (err) throw err;\n  console.log('done!');\n});\n```\n\n## About\n\n### Related projects\n\n* [assemble](https://www.npmjs.com/package/assemble): Get the rocks out of your socks! Assemble makes you fast at creating web projects… [more](https://github.com/assemble/assemble) | [homepage](https://github.com/assemble/assemble \"Get the rocks out of your socks! Assemble makes you fast at creating web projects. Assemble is used by thousands of projects for rapid prototyping, creating themes, scaffolds, boilerplates, e-books, UI components, API documentation, blogs, building websit\")\n* [templates](https://www.npmjs.com/package/templates): System for creating and managing template collections, and rendering templates with any node.js template engine… [more](https://github.com/jonschlinkert/templates) | [homepage](https://github.com/jonschlinkert/templates \"System for creating and managing template collections, and rendering templates with any node.js template engine. Can be used as the basis for creating a static site generator or blog framework.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Contributors\n\n| **Commits** | **Contributor** |  \n| --- | --- |  \n| 26 | [doowb](https://github.com/doowb) |  \n| 14 | [jonschlinkert](https://github.com/jonschlinkert) |  \n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme \u0026\u0026 verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install \u0026\u0026 npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on June 17, 2017._","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fassemble%2Fassemble-permalinks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fassemble%2Fassemble-permalinks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fassemble%2Fassemble-permalinks/lists"}