{"id":15196900,"url":"https://github.com/flowershow/remark-wiki-link-plus","last_synced_at":"2025-03-29T20:30:26.809Z","repository":{"id":57688862,"uuid":"473996494","full_name":"flowershow/remark-wiki-link-plus","owner":"flowershow","description":"Parse and render wiki-style links in markdown especially Obsidian style links.","archived":false,"fork":false,"pushed_at":"2023-01-12T16:30:50.000Z","size":358,"stargazers_count":31,"open_issues_count":4,"forks_count":6,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-03-22T19:13:20.344Z","etag":null,"topics":["remark-plugin"],"latest_commit_sha":null,"homepage":"","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/flowershow.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":"2022-03-25T12:15:02.000Z","updated_at":"2025-02-10T08:50:59.000Z","dependencies_parsed_at":"2023-02-09T12:46:20.342Z","dependency_job_id":null,"html_url":"https://github.com/flowershow/remark-wiki-link-plus","commit_stats":null,"previous_names":["life-itself/remark-wiki-link-plus"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flowershow%2Fremark-wiki-link-plus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flowershow%2Fremark-wiki-link-plus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flowershow%2Fremark-wiki-link-plus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flowershow%2Fremark-wiki-link-plus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flowershow","download_url":"https://codeload.github.com/flowershow/remark-wiki-link-plus/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246242623,"owners_count":20746296,"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":["remark-plugin"],"created_at":"2024-09-28T00:06:13.440Z","updated_at":"2025-03-29T20:30:26.302Z","avatar_url":"https://github.com/flowershow.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"🛑 This repository has been merged into [Flowershow monorepo](https://github.com/flowershow/flowershow).\n\n# remark-wiki-link-plus\n\nParse and render wiki-style links in markdown especially Obsidian style links.\n\n## What is this ?\n\nUsing obsidian, when we type in wiki link syntax for eg. `[[wiki_link]]` it would parse them as anchors.\n\n## Features supported\n\n- [x] Support `[[Internal link]]`\n- [x] Support `[[Internal link|With custom text]]`\n- [x] Support `[[Internal link#heading]]`\n- [x] Support `[[Internal link#heading|With custom text]]`\n- [x] Support `![[Document.pdf]]`\n- [x] Support `![[Image.png]]`\n* Supported image formats are jpg, jpeg, png, apng, webp, gif, svg, bmp, ico  \n* Unsupported image formats display a message for eg. `![[Image.xyz]]` would render the following:  \n`Document type XYZ is not yet supported for transclusions`\n\nFuture support:\n- [ ] Support `![[Audio.mp3]]`\n- [ ] Support `![[Video.mp4]]`\n- [ ] Support `![[Embed note]]`\n- [ ] Support `![[Embed note#heading]]`\n\n## Installation\n\n```bash\nnpm install remark-wiki-link-plus\n```\n\n## Usage\n\n```javascript\nconst unified = require('unified')\nconst markdown = require('remark-parse')\nconst wikiLinkPlugin = require('remark-wiki-link-plus');\n\nlet processor = unified()\n    .use(markdown, { gfm: true })\n    .use(wikiLinkPlugin)\n```\n\n### Configuration options\n\n* `options.markdownFolder [String]`: A string that points to the content folder.\n\n  The default `hrefTemplate` is:\n  \n```javascript\n(permalink) =\u003e `/${permalink}`\n```\n\n## Running the tests\n\n```bash\nnpm run test\n```\n\n# Change Log\n\n## [1.1.1] - 2022-11-14\n\n### Fixed\n\n- Permalinks not linking to case sensitive url paths \n  - eg. before `[[Page]]` generates `href=\"/page\"` but will now generate `href=\"/Page\"`\n\n## [1.1.0] - 2022-09-06\n\n### Added\n\n- Add support for more image formats\n  - apng, webp, gif, svg, bmp, ico\n- Add support for PDF documents\n- Add warning for unsupported image formats\n\n## [1.0.2] - 2022-08-11\n \n### Added\n\n- Add support for transclusion links / image links\n - png, jpg, jpeg\n \n## [1.0.1] - 2022-08-04\n\n### Changed\n\n- permalink for folders with an index file will tranform to folder name only. \nFor example, if the wikilink is [[docs/index]] the href will be '/docs'.\n\n### Fixed\n\n- broken links to filenames that matched the markdown folder name.\n  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflowershow%2Fremark-wiki-link-plus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflowershow%2Fremark-wiki-link-plus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflowershow%2Fremark-wiki-link-plus/lists"}