{"id":20853932,"url":"https://github.com/landakram/remark-wiki-link","last_synced_at":"2025-09-04T09:34:59.688Z","repository":{"id":42696361,"uuid":"115289715","full_name":"landakram/remark-wiki-link","owner":"landakram","description":"Parse and render wiki links.","archived":false,"fork":false,"pushed_at":"2023-10-10T00:35:13.000Z","size":1144,"stargazers_count":97,"open_issues_count":11,"forks_count":17,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-09T15:00:01.352Z","etag":null,"topics":["remark","remark-plugin","wiki"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/landakram.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-12-24T22:14:48.000Z","updated_at":"2025-07-23T09:45:09.000Z","dependencies_parsed_at":"2024-06-18T15:14:57.544Z","dependency_job_id":"c22c66ac-96af-4cd3-8a0d-26bfe0042508","html_url":"https://github.com/landakram/remark-wiki-link","commit_stats":{"total_commits":37,"total_committers":4,"mean_commits":9.25,"dds":0.1351351351351351,"last_synced_commit":"421e2ae40d8bc00dd52ac8ef22d306b736206318"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/landakram/remark-wiki-link","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/landakram%2Fremark-wiki-link","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/landakram%2Fremark-wiki-link/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/landakram%2Fremark-wiki-link/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/landakram%2Fremark-wiki-link/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/landakram","download_url":"https://codeload.github.com/landakram/remark-wiki-link/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/landakram%2Fremark-wiki-link/sbom","scorecard":{"id":578279,"data":{"date":"2025-08-11","repo":{"name":"github.com/landakram/remark-wiki-link","commit":"421e2ae40d8bc00dd52ac8ef22d306b736206318"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.8,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":1,"reason":"Found 2/11 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/node.js.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":3,"reason":"dependency not pinned by hash detected -- score normalized to 3","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/landakram/remark-wiki-link/node.js.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/landakram/remark-wiki-link/node.js.yml/master?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   1 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 26 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"19 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-2j2x-2gpw-g8fm","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5","Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-20T18:26:37.788Z","repository_id":42696361,"created_at":"2025-08-20T18:26:37.788Z","updated_at":"2025-08-20T18:26:37.788Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273584177,"owners_count":25132014,"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","status":"online","status_checked_at":"2025-09-04T02:00:08.968Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","remark-plugin","wiki"],"created_at":"2024-11-18T03:23:48.819Z","updated_at":"2025-09-04T09:34:59.633Z","avatar_url":"https://github.com/landakram.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# remark-wiki-link\n[![npm version](https://badge.fury.io/js/remark-wiki-link.svg)](https://badge.fury.io/js/remark-wiki-link) [![Build Status](https://travis-ci.org/landakram/remark-wiki-link.svg?branch=master)](https://travis-ci.org/landakram/remark-wiki-link)\n\n⚠️ This plugin is affected by the new parser in remark ([`micromark`](https://github.com/micromark/micromark), see [`remarkjs/remark#536`](https://github.com/remarkjs/remark/pull/536)). **For remark 12, use v0.0.x of this package**. **For remark 13+, use v1.0.0 or above.**\n\nThis [remark](https://github.com/wooorm/remark) plugin parses and renders `[[Wiki Links]]`.\n\n* Parse wiki-style links and render them as anchors\n* Differentiate between \"new\" and \"existing\" wiki links by giving the parser a list of existing permalinks\n* Parse aliased wiki links i.e `[[Real Page:Page Alias]]`\n\nLooking for lower level packages? Check out [mdast-util-wiki-link](https://github.com/landakram/mdast-util-wiki-link/) for working with ASTs and [micromark-extension-wiki-link](https://github.com/landakram/micromark-extension-wiki-link) for working with tokens.\n\n## Usage\n\n```javascript\nconst unified = require('unified')\nconst markdown = require('remark-parse')\nconst wikiLinkPlugin = require('remark-wiki-link');\n\nlet processor = unified()\n    .use(markdown, { gfm: true })\n    .use(wikiLinkPlugin)\n```\n\nWhen the processor is run, wiki links will be parsed to a `wikiLink` node. \n\nIf we have this markdown string: \n\n```\n[[Test Page]]\n```\n\nA node will be created that looks like this:\n\n```javascript\n{\n    value: 'Test Page',\n    data: {\n        alias: 'Test Page',\n        permalink: 'test_page',\n        exists: false,\n        hName: 'a',\n        hProperties: {\n            className: 'internal new',\n            href: '#/page/test_page'\n        },\n        hChildren: [{\n            type: 'text',\n            value: 'Test Page'\n        }]\n    }\n}\n```\n\n* `data.alias`: The display name for this link\n* `data.permalink`: The permalink for this page. This permalink is computed from `node.value` using `options.pageResolver`, which can be passed in when initializing the plugin. \n* `data.exists`: Whether the page exists. A page exists if its permalink is found in `options.permalinks`, passed when initializing the plugin.\n* `data.hProperties.className`: Classes that are automatically attached to the `a` when it is rendered as HTML. These are configurable with `options.wikiLinkClassName` and `options.newClassName`. `options.newClassName` is attached when `data.exists` is false.\n* `data.hProperties.href`: `href` value for the rendered `a`. This `href` is computed using `options.hrefTemplate`.\n\nWhen rendered to HTML, we get:\n\n```\n\u003ca class=\"internal new\" href=\"#/page/test_page\"\u003eTest Page\u003c/a\u003e\n```\n\n### Configuration options\n\n* `options.permalinks [String]`: An array of permalinks that should be considered existing pages. If a wiki link is parsed and its permalink matches one of these permalinks, `node.data.exists` will be true.\n* `options.pageResolver (pageName: String) -\u003e [String]`: A function that maps a page name to an array of possible permalinks. These possible permalinks are cross-referenced with `options.permalinks` to determine whether a page exists. If a page doesn't exist, the first element of the array is considered the permalink.\n\n  The default `pageResolver` is:\n\n```javascript\n(name) =\u003e [name.replace(/ /g, '_').toLowerCase()]\n```\n\n* `options.hrefTemplate (permalink: String) -\u003e String`: A function that maps a permalink to some path. This path is used as the `href` for the rendered `a`.\n\n  The default `hrefTemplate` is:\n  \n```javascript\n(permalink) =\u003e `#/page/${permalink}`\n```\n\n* `options.wikiLinkClassName`: a class name that is attached to any rendered wiki links. Defaults to `\"internal\"`.\n* `options.newClassName`: a class name that is attached to any rendered wiki links that do not exist. Defaults to `\"new\"`.\n* `options.aliasDivider`: a string for `aliased pages`.\n\n#### Aliasing pages\n\nAliased pages are supported with the following markdown syntax: \n\n```\n[[Real Page:Page Alias]]\n```\n\nThe AST node will look like: \n\n```javascript\n{\n    value: 'Real Page',\n    data: {\n        alias: 'Page Alias',\n        permalink: 'real_page',\n        exists: false,\n        hName: 'a',\n        hProperties: {\n            className: 'internal new',\n            href: '#/page/real_page'\n        },\n        hChildren: [{\n            type: 'text',\n            value: 'Page Alias'\n        }]\n    }\n}\n```\n\nAnd will produce this HTML when rendered:\n\n```\n\u003ca class=\"internal new\" href=\"#/page/real_page\"\u003ePage Alias\u003c/a\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flandakram%2Fremark-wiki-link","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flandakram%2Fremark-wiki-link","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flandakram%2Fremark-wiki-link/lists"}