{"id":20258627,"url":"https://github.com/roderickqiu/vuepress-plugin-internal-link","last_synced_at":"2025-04-11T01:02:15.188Z","repository":{"id":65519650,"uuid":"282385835","full_name":"RoderickQiu/vuepress-plugin-internal-link","owner":"RoderickQiu","description":"Parse [[internal link]] into normal markdown links to let them be supported in vuepress, which is useful for Wiki writers and researchers.","archived":false,"fork":false,"pushed_at":"2020-07-29T06:30:53.000Z","size":5,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-07T20:04:22.860Z","etag":null,"topics":["documentation","generator","glossary","internal","internal-links","link","markdown-it","markdown-it-plugin","notes","roamresearch","vue","vuepress","vuepress-plugin","wiki"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/vuepress-plugin-internal-link","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/RoderickQiu.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":"2020-07-25T06:29:42.000Z","updated_at":"2022-08-12T17:11:52.000Z","dependencies_parsed_at":"2023-01-27T02:10:25.673Z","dependency_job_id":null,"html_url":"https://github.com/RoderickQiu/vuepress-plugin-internal-link","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoderickQiu%2Fvuepress-plugin-internal-link","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoderickQiu%2Fvuepress-plugin-internal-link/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoderickQiu%2Fvuepress-plugin-internal-link/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoderickQiu%2Fvuepress-plugin-internal-link/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RoderickQiu","download_url":"https://codeload.github.com/RoderickQiu/vuepress-plugin-internal-link/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248322599,"owners_count":21084336,"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":["documentation","generator","glossary","internal","internal-links","link","markdown-it","markdown-it-plugin","notes","roamresearch","vue","vuepress","vuepress-plugin","wiki"],"created_at":"2024-11-14T11:10:02.375Z","updated_at":"2025-04-11T01:02:15.156Z","avatar_url":"https://github.com/RoderickQiu.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vuepress-plugin-internal-link\n\nWhen setting up wikis or taking notes, `[[internal links]]` are useful. However, vuepress itself doens't have a convient way of having internal links. And that's what this plugin is for.\n\n## Install and Use\n\n### 1. Installation\n\nSimply use yarn to fetch this package for you. NPM is also OK.\n\n```shell\nyarn add vuepress-plugin-internal-link\n```\n\n### 2. Configuration\n\nIt's extremely easy to use this plugin.\n\nFind your `.vuepress/config.js`, and just write down:\n\n```js\nplugins: {\n    'internal-link': {}\n}\n```\n\nThen the whole world is your oyster.\n\n#### Use with custom parsing pattern\n\nThe default pattern can only parse English and Chinese, so in some cases you may need to use another pattern.\n\nFind your `.vuepress/config.js`, and write down:\n\n```js\nplugins: {\n    'internal-link': {\n        linkPattern: /YOUR_PATTERN/\n    }\n}\n```\n\nThe pattern should be a valid regex.\n\n### 3. Usage\n\nTo use internal link, you need to write stuff like `[[link]]` and `[[another link]]`, which will resulted in an internal link to `./link.md` or `./link.html` after building.\n\nThis internal link feature can be used to export articles from platforms like [Obsidian](https://obsidian.md).\n\nAlso, for VSCode users, don't hesitate to try [Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes).\n\n## Acknowledgements\n\n- Based on [ig3/markdown-it-wikilinks](https://github.com/ig3/markdown-it-wikilinks) by [jsepia](https://github.com/jsepia) and [ig3](https://github.com/ig3).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froderickqiu%2Fvuepress-plugin-internal-link","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froderickqiu%2Fvuepress-plugin-internal-link","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froderickqiu%2Fvuepress-plugin-internal-link/lists"}