{"id":25646622,"url":"https://github.com/vrongmeal/jekyll-github","last_synced_at":"2026-05-10T05:02:34.833Z","repository":{"id":56878609,"uuid":"165054607","full_name":"vrongmeal/jekyll-github","owner":"vrongmeal","description":"Jekyll plugin for Github","archived":false,"fork":false,"pushed_at":"2019-01-13T21:37:13.000Z","size":7,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-25T01:21:18.628Z","etag":null,"topics":["github","jekyll","jekyll-plugin"],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/jekyll-github","language":"Ruby","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/vrongmeal.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":"2019-01-10T12:17:31.000Z","updated_at":"2019-01-13T21:39:13.000Z","dependencies_parsed_at":"2022-08-20T11:40:39.297Z","dependency_job_id":null,"html_url":"https://github.com/vrongmeal/jekyll-github","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vrongmeal%2Fjekyll-github","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vrongmeal%2Fjekyll-github/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vrongmeal%2Fjekyll-github/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vrongmeal%2Fjekyll-github/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vrongmeal","download_url":"https://codeload.github.com/vrongmeal/jekyll-github/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240304138,"owners_count":19780309,"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":["github","jekyll","jekyll-plugin"],"created_at":"2025-02-23T10:29:49.774Z","updated_at":"2026-05-10T05:02:29.796Z","avatar_url":"https://github.com/vrongmeal.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jekyll-github\n\nJekyll plugin for Github\n\n[![Gem Version](https://badge.fury.io/rb/jekyll-github.svg)](https://badge.fury.io/rb/jekyll-github)\n\n## Installing\n\n1. Add `jekyll-github` to your Gemfile:\n    ```\n    gem 'jekyll-github'\n    ```\n\n2. Add the following to your site's `_config.yml`:\n    ```yml\n    plugins:\n        - jekyll-github\n    ```\n\n## How to use it?\n\n* You can add github links simply by adding the string `gh@`.\n\n* You can add the following in your markdown:\n    * **mention:** `gh@vrongmeal`\n\n        This gives the result [@vrongmeal](https://github.com/vrongmeal)\n\n    * **repository:** `gh@vrongmeal/readit`\n    * **repository at a branch:** `gh@vrongmeal/dayts:gh-pages`\n    * **issue or a pull request:** `gh@vrongmeal/dayts#2`\n    * **file or directory:** `gh@vrongmeal/dayts/src/index.js`\n    * **file or directory at a branch:** `gh@vrongmeal/dayts:gh-pages/bundle.js`\n    * **tag (releases):** `gh@vrongmeal/zulip=1.8.1`\n\n* As you might see, there are certain components in every command type. The following are all the components:\n    * `user` as in mention\n    * `repo` as in repository\n    * `branch` as in repository at a branch\n    * `issue_pr` in issue or pull request\n    * `file` path of file or file at a branch\n    * `tag` as in tag (releases)\n    * `link` for github link (valid for all)\n\nLet's configure the plugin.\n\n## Configuration\n\nYou can configure the plugin either globally (in `_config.yml`) or in particular page (at the top of page between the two `---`). The settings in the page will take preference.\n\nThe configuration is for defining the format string for the output of commands. Let's see through an example:\n\n```yml\njekyll-github:\n    mention: '@\u003cuser\u003e'\n    repo: '\u003cuser\u003e/\u003crepo\u003e'\n    repo_branch: '\u003cuser\u003e/\u003crepo\u003e:\u003cbranch\u003e'\n    issue_pr: '#\u003cissue_pr\u003e'\n    file: '\u003crepo\u003e/\u003cfile\u003e'\n    file_branch: '\u003crepo\u003e:\u003cbranch\u003e/\u003cfile\u003e'\n    tag: '\u003crepo\u003e=\u003ctag\u003e'\n```\n\nThis above is the default configuration of the plugin. Let's cutomize it by saying we need complete link for a github file on a page. Simply, we can add the following setting on the top of the page:\n\n```yml\njekyll-github:\n    file: '\u003clink\u003e'\n```\n\n## Summary\n\n| Link to | Setting key | Markdown syntax |\n| --- | --- | --- |\n| mention | `mention` | `gh@\u003cuser\u003e` |\n| repository | `repo` | `gh@\u003cuser\u003e/\u003crepo\u003e` |\n| repository at a branch | `repo_branch` | `gh@\u003cuser\u003e/\u003crepo\u003e:\u003cbranch\u003e` |\n| issue or a pull request | `issue_pr` | `gh@\u003cuser\u003e/\u003crepo\u003e#\u003cissue_pr\u003e` |\n| file | `file` | `gh@\u003cuser\u003e/\u003crepo\u003e/\u003cfile\u003e` |\n| file at a branch | `file_branch` | `gh@\u003cuser\u003e/\u003crepo\u003e:\u003cbranch\u003e/\u003cfile\u003e` |\n| tag (releases) | `tag` | `gh@\u003cuser\u003e/\u003crepo\u003e=\u003ctag\u003e` |\n\nAnd now you have the power of github in your jekyll site!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvrongmeal%2Fjekyll-github","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvrongmeal%2Fjekyll-github","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvrongmeal%2Fjekyll-github/lists"}