{"id":18429441,"url":"https://github.com/bigpipe/bigpipe-layout","last_synced_at":"2025-04-13T21:44:28.078Z","repository":{"id":10772781,"uuid":"13038033","full_name":"bigpipe/bigpipe-layout","owner":"bigpipe","description":"Supply default layout to Bigpipe pages","archived":false,"fork":false,"pushed_at":"2016-11-16T20:43:01.000Z","size":14,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-07T08:38:07.219Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/bigpipe.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":"2013-09-23T14:30:31.000Z","updated_at":"2021-12-16T14:00:06.000Z","dependencies_parsed_at":"2022-09-02T00:10:18.468Z","dependency_job_id":null,"html_url":"https://github.com/bigpipe/bigpipe-layout","commit_stats":null,"previous_names":["moveo/bigpipe-layout"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigpipe%2Fbigpipe-layout","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigpipe%2Fbigpipe-layout/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigpipe%2Fbigpipe-layout/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigpipe%2Fbigpipe-layout/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigpipe","download_url":"https://codeload.github.com/bigpipe/bigpipe-layout/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248788868,"owners_count":21161726,"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-06T05:17:11.039Z","updated_at":"2025-04-13T21:44:28.038Z","avatar_url":"https://github.com/bigpipe.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## This plugin is deprecated, as the new pagelet-only structure, will provide the same functionality through the  [bootstrap Pagelet](https://github.com/bigpipe/bootstrap-pagelet)\n\n# Layout [![Build Status][status]](https://travis-ci.org/bigpipe/plugin-layout) [![NPM version][npmimgurl]](http://badge.fury.io/js/bigpipe-layout) [![Coverage Status][coverage]](http://coveralls.io/r/bigpipe/plugin-layout?branch=master)\n\n[status]: https://travis-ci.org/bigpipe/plugin-layout.png\n[npmimgurl]: https://badge.fury.io/js/bigpipe-layout.png\n[coverage]: http://coveralls.io/repos/bigpipe/plugin-layout/badge.png?branch=master\n\n[Bigpipe] plugin that will provide an easy method to add a general layout to\npages. The Bigpipe#Temper instance is used to load your provided layout. The\ntemplate engine of the file is automatically detected. The page is supplied to\nthe layout as `partial` by default, changable through options#key.\n\n[Bigpipe]: https://github.com/bigpipe/bigpipe\n\n## Features\n\n- Provide default layout to each page\n- Utilizes Bigpipe#[Temper] to automatically detect the template engine\n- Fully customizable layout page, options provide full control\n\nExample of layout file using the [embedded js] template egine\n\n```html\n\u003cdiv\u003e\u003c%- partial %\u003e\u003c/div\u003e\n```\n\n[Temper]: https://github.com/bigpipe/temper\n[embedded js]: https://github.com/visionmedia/ejs\n\n## Installation\n\nThe layout plugin is released to npm and can be installed using:\n\n```bash\nnpm install bigpipe-layout --save\n```\n\nTo use the plugin from Bigpipe, simply add it after Bigpipe is initialized or\nadd it to options#plugins. `bigpipe.use` will execute the plugin logic. Make sure\nthe plugin name is unique, e.g. `layout` by default.\n\n```js\n// Usage after initialization\nvar layout = require('bigpipe-layout')\n  , BigPipe = require('bigpipe');\n\n//\n// Add valid path to base layout.\n//\nlayout.options = { base: '/path/to/base/layout.ejs' };\nlayout.key = 'custom';\n\nvar pipe = new BigPipe(http.createServer(), {\n  pages: __dirname + '/pages',\n  public: __dirname + '/public'\n}).listen(8080).use(layout);\n```\n\n```js\n// Usage through createServer options\nvar layout = require('bigpipe-layout')\n  , BigPipe = require('bigpipe');\n\n//\n// Add valid path to base layout.\n//\nlayout.options = { base: '/path/to/base/layout.ejs' };\n\nvar pipe = BigPipe.createServer(8080, {\n  pages: __dirname + '/pages',\n  public: __dirname + '/public',\n  plugins: [ layout ]\n});\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigpipe%2Fbigpipe-layout","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigpipe%2Fbigpipe-layout","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigpipe%2Fbigpipe-layout/lists"}