https://github.com/thedragoncode/vuepress-plugin-github-linkify

Adding and fixing GitHub links for Vuepress 2
https://github.com/thedragoncode/vuepress-plugin-github-linkify

github github-linkify link linkify links vuepress vuepress-plugin

Last synced: 4 months ago
JSON representation

Adding and fixing GitHub links for Vuepress 2

• Host: GitHub
• URL: https://github.com/thedragoncode/vuepress-plugin-github-linkify
• Owner: TheDragonCode
• License: mit
• Created: 2023-02-26T00:05:34.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-01-02T16:42:00.000Z (about 1 year ago)
• Last Synced: 2025-06-29T00:26:39.589Z (7 months ago)
• Topics: github, github-linkify, link, linkify, links, vuepress, vuepress-plugin
• Language: TypeScript
• Homepage:
• Size: 413 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Vuepress Plugin GitHub Linkify

![the dragon code github linkify](https://preview.dragon-code.pro/the-dragon-code/github-linkify.svg?brand=vuepress&mode=dark)

Finding and fixing GitHub links

[![NPM version][npm-version-image]][npm-url]

[![NPM downloads][npm-downloads-image]][npm-downloads-url]

[![MIT License][license-image]][license-url]

## Usage

```bash

npm i -D vuepress-plugin-github-linkify

```

```javascript

// .vuepress/config.js

import { githubLinkifyPlugin } from 'vuepress-plugin-github-linkify'

{

    plugins: [

        githubLinkifyPlugin({

            repo: 'your-vendor/your-project'

        })

    ]

}

```

### Support Links

* [x] mentions

* [x] commits

* [x] pull requests

* [x] compares

* [x] tags

* [x] trees

* [x] blobs

## Example

![before](.github/images/before.png)

![after](.github/images/after.png)

## License

This package is licensed under the [MIT License][license-url].

[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat

[license-url]: LICENSE

[npm-url]: https://npmjs.org/package/vuepress-plugin-github-linkify

[npm-version-image]: https://img.shields.io/npm/v/vuepress-plugin-github-linkify.svg?style=flat

[npm-downloads-image]: https://img.shields.io/npm/dm/vuepress-plugin-github-linkify.svg?style=flat

[npm-downloads-url]: https://npmcharts.com/compare/vuepress-plugin-github-linkify?minimal=true