{"id":15016491,"url":"https://github.com/5t3ph/eleventy-plugin-template","last_synced_at":"2025-10-19T13:09:18.648Z","repository":{"id":54301921,"uuid":"308958187","full_name":"5t3ph/eleventy-plugin-template","owner":"5t3ph","description":"A starter environment for creating plugins for Eleventy (11ty).","archived":false,"fork":false,"pushed_at":"2023-02-11T01:48:36.000Z","size":26,"stargazers_count":52,"open_issues_count":3,"forks_count":8,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-26T04:34:55.233Z","etag":null,"topics":["11ty","11ty-plugin","eleventy","eleventy-plugin"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/5t3ph.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-31T19:35:55.000Z","updated_at":"2025-02-20T10:17:25.000Z","dependencies_parsed_at":"2022-08-13T11:30:24.506Z","dependency_job_id":null,"html_url":"https://github.com/5t3ph/eleventy-plugin-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/5t3ph%2Feleventy-plugin-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/5t3ph%2Feleventy-plugin-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/5t3ph%2Feleventy-plugin-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/5t3ph%2Feleventy-plugin-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/5t3ph","download_url":"https://codeload.github.com/5t3ph/eleventy-plugin-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248546017,"owners_count":21122246,"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":["11ty","11ty-plugin","eleventy","eleventy-plugin"],"created_at":"2024-09-24T19:48:59.027Z","updated_at":"2025-10-19T13:09:18.580Z","avatar_url":"https://github.com/5t3ph.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Eleventy Plugin Template\n\n\u003e A starter environment for creating plugins for Eleventy (11ty).\n\nFork this repo, or select \"Use this template\" to get started.\n\n### Using this template\n\nThis template is setup to run a single page 11ty site for testing your plugin functionality. The build files are excluded from the final plugin package via `.npmignore`.\n\nYour plugin functionality should live in/be exported from `.eleventy.js`. You will find a sample of creating a filter plugin in this template, including setting up a default config and merging user options.\n\n**Be sure to update the `package.json` with your own details!**\n\n### Testing your plugin\n\nYou can test your functionality within this project's local 11ty build by running `npm start`, but you'll also want to test it _as a plugin_.\n\nFrom another local 11ty project, you can set the `require()` path relatively to your plugin's project directory, and then use it just as you would for a plugin coming from a package.\n\nExample, assuming you place all your repositories within the same parent directory:\n\n```js\nconst pluginName = require(\"../plugin-directory\");\n\nmodule.exports = (eleventyConfig) =\u003e {\n  eleventyConfig.addPlugin(pluginName, { optionName: 'if needed' );\n};\n```\n\nThen, run the project to test the plugin's functionality.\n\nNote that making changes in the plugin source will likely require restarting the test project.\n\n### Resources for creating an 11ty plugin\n\n- Bryan Robinson's [\"Create a Plugin with 11ty\"](https://www.youtube.com/watch?v=aO-NFFKjnnE) demonstration on \"Learn With Jason\"\n\n---\n\n**The following is a boilerplate for your final plugin README**.\n\n## Usage\n\nDescribe how to install your plugin, such as:\n\n```bash\nnpm install @scope/plugin-name\n```\n\nThen, include it in your `.eleventy.js` config file:\n\n```js\nconst pluginName = require(\"@scope/plugin-name\");\n\nmodule.exports = (eleventyConfig) =\u003e {\n  eleventyConfig.addPlugin(pluginName);\n};\n```\n\n## Config Options\n\n| Option      | Type | Default       |\n| ----------- | ---- | ------------- |\n| option name | type | default value |\n\n## Config Examples\n\nShow examples of likely configurations.\n\n## Credits\n\nAdd credits if needed.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F5t3ph%2Feleventy-plugin-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F5t3ph%2Feleventy-plugin-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F5t3ph%2Feleventy-plugin-template/lists"}