https://github.com/gimenete/github-linker

VSCode extension to create permanent links to pieces of code
https://github.com/gimenete/github-linker

Last synced: 16 days ago
JSON representation

VSCode extension to create permanent links to pieces of code

• Host: GitHub
• URL: https://github.com/gimenete/github-linker
• Owner: gimenete
• Created: 2018-12-19T18:30:20.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T10:48:34.000Z (almost 2 years ago)
• Last Synced: 2024-10-04T12:59:13.609Z (about 1 month ago)
• Language: TypeScript
• Size: 9.28 MB
• Stars: 26
• Watchers: 1
• Forks: 15
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# GitHub Linker

## Features

GitHub linker allows you to select a piece of text and create a permanent link to GitHub.com for that piece of text. Just select the text, right click, and you'll see two new options.

**Copy a permanent link to the clipboard**

![](gifs/github-linker.gif)

For example:

https://github.com/integrations/jira/blob/d1a890ae8a7092ca08cb9fdf527fcc25f471e68c/lib/models/index.js#L9-L15

**Copy a permanent link and code as markdown**

![](gifs/github-linker2.gif)

The second option not only copies the link but also copies the piece of selected text properly wrapped in a markdown code block with the programming language correctly specified. For example:

    https://github.com/integrations/jira/blob/d1a890ae8a7092ca08cb9fdf527fcc25f471e68c/lib/models/index.js#L9-L15

    ```javascript

    Object.assign(config, {

      operatorsAliases: false,

      benchmark: true,

      logging: (query, ms) => {

        logger.debug({ ms }, query)

      }

    })

    ```

Which will be rendered as:

https://github.com/integrations/jira/blob/d1a890ae8a7092ca08cb9fdf527fcc25f471e68c/lib/models/index.js#L9-L15

```javascript

Object.assign(config, {

  operatorsAliases: false,

  benchmark: true,

  logging: (query, ms) => {

    logger.debug({ ms }, query)

  }

})

```

## Requirements

The file must be tracked in a git repo and the current branch must be pushed to GitHub.com.

If you've made changes to the file that are not pushed to GitHub.com, the link may be inaccurate.

**Enjoy!**

Extension icon made by [Freepik](https://www.freepik.com/ "Freepik") from [www.flaticon.com](https://www.flaticon.com/ "Flaticon") is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/ "Creative Commons BY 3.0")