{"id":15698950,"url":"https://github.com/doowb/remarkable-mentions","last_synced_at":"2025-05-09T02:15:25.833Z","repository":{"id":57353121,"uuid":"69119539","full_name":"doowb/remarkable-mentions","owner":"doowb","description":"Transform @ mentions into markdown links.","archived":false,"fork":false,"pushed_at":"2016-09-24T18:23:11.000Z","size":10,"stargazers_count":6,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-09T02:15:20.646Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/doowb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-09-24T18:12:57.000Z","updated_at":"2021-11-24T10:44:10.000Z","dependencies_parsed_at":"2022-09-18T23:21:46.365Z","dependency_job_id":null,"html_url":"https://github.com/doowb/remarkable-mentions","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/doowb%2Fremarkable-mentions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doowb%2Fremarkable-mentions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doowb%2Fremarkable-mentions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doowb%2Fremarkable-mentions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/doowb","download_url":"https://codeload.github.com/doowb/remarkable-mentions/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253176444,"owners_count":21866143,"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":[],"created_at":"2024-10-03T19:36:24.696Z","updated_at":"2025-05-09T02:15:25.807Z","avatar_url":"https://github.com/doowb.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# remarkable-mentions [![NPM version](https://img.shields.io/npm/v/remarkable-mentions.svg?style=flat)](https://www.npmjs.com/package/remarkable-mentions) [![NPM downloads](https://img.shields.io/npm/dm/remarkable-mentions.svg?style=flat)](https://npmjs.org/package/remarkable-mentions) [![Build Status](https://img.shields.io/travis/doowb/remarkable-mentions.svg?style=flat)](https://travis-ci.org/doowb/remarkable-mentions)\n\nTransform @ mentions into markdown links.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save remarkable-mentions\n```\n\n## Usage\n\n```js\nvar mentions = require('remarkable-mentions');\n```\n\n## API\n\n### [mentions](index.js#L22)\n\nRemarkable plugin that will turn all @ mentions into a link. This is done just after block tokenizing to ensure that the inline blocks are transformed before links are transformed. This also ensures that @ mentions inside code blocks are not transformed.\n\n**Params**\n\n* `options` **{Object}**: Options to control how the @ mentions are transformed. See [to-mention-link](https://github.com/doowb/to-mention-link) for more options.\n* `options.url` **{String}**: Customize the url that is used in the links. Defaults to \"https://github.com\".\n* `returns` **{Function}**: Remarkable plugin function that can be passed to the `.use` method.\n\n**Example**\n\n```js\nvar md = new Remarkable();\nmd.use(mentions());\nvar html = md.render(markdown);\n```\n\n## About\n\n### Related projects\n\n* [markdown-link](https://www.npmjs.com/package/markdown-link): Micro util for generating a single markdown link. | [homepage](https://github.com/jonschlinkert/markdown-link \"Micro util for generating a single markdown link.\")\n* [parse-mentions](https://www.npmjs.com/package/parse-mentions): Parse and optionally replace @ mentions from a string of text. | [homepage](https://github.com/doowb/parse-mentions \"Parse and optionally replace @ mentions from a string of text.\")\n* [remarkable](https://www.npmjs.com/package/remarkable): Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… [more](https://github.com/jonschlinkert/remarkable) | [homepage](https://github.com/jonschlinkert/remarkable \"Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in one.\")\n* [to-mention-link](https://www.npmjs.com/package/to-mention-link): Create links from @ mentions. | [homepage](https://github.com/doowb/to-mention-link \"Create links from @ mentions.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\nPlease read the [contributing guide](contributing.md) for avice on opening issues, pull requests, and coding standards.\n\n### Building docs\n\n_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_\n\nTo generate the readme and API documentation with [verb](https://github.com/verbose/verb):\n\n```sh\n$ npm install -g verb verb-generate-readme \u0026\u0026 verb\n```\n\n### Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm install -d \u0026\u0026 npm test\n```\n\n### Author\n\n**Brian Woodward**\n\n* [github/doowb](https://github.com/doowb)\n* [twitter/doowb](http://twitter.com/doowb)\n\n### License\n\nCopyright © 2016, [Brian Woodward](https://github.com/doowb).\nReleased under the [MIT license](https://github.com/doowb/remarkable-mentions/blob/master/LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.30, on September 24, 2016._","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoowb%2Fremarkable-mentions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdoowb%2Fremarkable-mentions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoowb%2Fremarkable-mentions/lists"}