{"id":15022939,"url":"https://github.com/christopherpickering/eleventy-plugin-edit-on-github","last_synced_at":"2025-10-25T00:31:49.833Z","repository":{"id":37832080,"uuid":"505832264","full_name":"christopherpickering/eleventy-plugin-edit-on-github","owner":"christopherpickering","description":"Eleventy plugin to add an \"Edit on Github\" link to pages.","archived":false,"fork":false,"pushed_at":"2025-02-09T13:57:29.000Z","size":2268,"stargazers_count":4,"open_issues_count":2,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-02-09T14:37:52.190Z","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/christopherpickering.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"christopherpickering","custom":"https://venmo.com/code?user_id=3118520086822912596\u0026created=1655827155"}},"created_at":"2022-06-21T12:24:30.000Z","updated_at":"2025-02-09T13:57:02.000Z","dependencies_parsed_at":"2023-11-12T10:24:18.276Z","dependency_job_id":"6d9dd985-e835-4960-a90d-a203e9d0891a","html_url":"https://github.com/christopherpickering/eleventy-plugin-edit-on-github","commit_stats":{"total_commits":162,"total_committers":4,"mean_commits":40.5,"dds":0.0679012345679012,"last_synced_commit":"efafba28112c9b8683955bfe89f263d80e25bb3b"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christopherpickering%2Feleventy-plugin-edit-on-github","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christopherpickering%2Feleventy-plugin-edit-on-github/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christopherpickering%2Feleventy-plugin-edit-on-github/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christopherpickering%2Feleventy-plugin-edit-on-github/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/christopherpickering","download_url":"https://codeload.github.com/christopherpickering/eleventy-plugin-edit-on-github/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237968588,"owners_count":19394975,"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-09-24T19:58:33.521Z","updated_at":"2025-10-25T00:31:49.440Z","avatar_url":"https://github.com/christopherpickering.png","language":"JavaScript","funding_links":["https://github.com/sponsors/christopherpickering","https://venmo.com/code?user_id=3118520086822912596\u0026created=1655827155"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eeleventy-plugin-edit-on-github\u003c/h1\u003e\n\n\u003ch4 align=\"center\"\u003eAn Eleventy \u003ca href=\"https://www.11ty.dev/docs/shortcodes/\"\u003eshortcode\u003c/a\u003e to add an \"Edit on Github\" link to your pages.\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://twitter.com/intent/tweet?text=eleventy-plugin-edit-on-github%20%7C%20An%20Eleventy%20shortcode%20to%20add%20an%20%22Edit%20on%20Github%22%20link%20to%20your%20pages.\u0026url=https://www.npmjs.com/package/eleventy-plugin-edit-on-github\u0026hashtags=eleventy,eleventy-plugin,github\"\u003e\u003cimg alt=\"tweet\" src=\"https://img.shields.io/twitter/url/http/shields.io.svg?style=social\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.npmjs.com/package/eleventy-plugin-edit-on-github\"\u003e\u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/v/eleventy-plugin-edit-on-github\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## 🚀 Installation\n\nInstall from [npm](https://www.npmjs.com/package/eleventy-plugin-edit-on-github):\n\n```bash\nnpm i -D eleventy-plugin-edit-on-github\n```\n\n## 😎 What does it do?\n\nThis is a very useful tool for documentation sites where you'd like your readers to point out updates easily. Add an \"Edit on Github\" link to your pages that will directly open the github editor for your source files!\n\n## 🏃 Usage\n\nSimply add this shortcode in your templates where you would like the link to appear.\n\n```\n{% gh_edit page %}\n```\n\n## ⚙️ Configuration\n\nThis plugin has one required parameter `github_edit_repo`, which should be the link to your github repository. If files are not at the root, you can also add the `github_edit_path` parameter.\n\nAdd to your Eleventy config file:\n\n```js\nconst editOnGithub = require('eleventy-plugin-edit-on-github');\n\nmodule.exports = function (eleventyConfig) {\n  eleventyConfig.addPlugin(editOnGithub, {\n    // required\n    github_edit_repo: 'https://github.com/christopherpickering/going-bg',\n    // optional: defaults\n    github_edit_path: undefined, // non-root location in git url. root is assumed\n    github_edit_branch: 'master',\n    github_edit_text: 'Edit on Github', // html accepted, or javascript function: (page) =\u003e { return page.inputPath}\n    github_edit_class: 'edit-on-github',\n    github_edit_tag: 'a',\n    github_edit_attributes: 'target=\"_blank\" rel=\"noopener\"',\n    github_edit_wrapper: undefined, //ex: \"\u003cdiv stuff\u003e${edit_on_github}\u003c/div\u003e\"\n  });\n};\n```\n\nCheck out the [sample](https://github.com/christopherpickering/eleventy-plugin-edit-on-github/tree/master/sample) site, or clone and run locally with `npm test`.\n\n## 🦘 Out in the Wild\n\n- [djLint docs](https://djlint.com) \u003e With i18n\n- [Atlas BI Library docs](https://www.atlas.bi/docs/bi-library/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristopherpickering%2Feleventy-plugin-edit-on-github","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchristopherpickering%2Feleventy-plugin-edit-on-github","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristopherpickering%2Feleventy-plugin-edit-on-github/lists"}