Skip to content
diaspora* mentions for markdown-it markdown parser.
JavaScript Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
test
.editorconfig
.eslintignore
.eslintrc.json
.gitignore
.npmignore
.travis.yml
CHANGELOG.md
LICENSE
Makefile
README.md
bower.json
index.js
package.json

README.md

markdown-it-diaspora-mention

Build Status Coverage Status npm version

diaspora-style @mention plugin for markdown-it markdown parser.

@{user@pod.tld} => @<a href="/people/1337" class="mention">User Name</a>

@{User Name; user@pod.tld} => @<a href="/people/1337" class="mention">User Name</a>

Install

node.js, bower:

npm install markdown-it-diaspora-mention --save
bower install markdown-it-diaspora-mention --save

Use

var md = require("markdown-it")()
            .use(require("markdown-it-diaspora-mention"), {
              mentions: [
                {
                  diaspora_id: "user@pod.tld",
                  guid: 1337,
                  name: "Alice Awesome"
                },
                {
                  handle: "foo@bar.baz",
                  url: "/my/awesome/url",
                  guid: 42,
                  name: "Foo Bar"
                }
              ],
              allowHovercards: true,
              currentUserId: 1337
            });

md.render("@{User Name; user@pod.tld}"); // => "@<a href='/people/1337' class='mention'>User Name</a>"
md.render("@{user@pod.tld}"); // => "@<a href='/people/1337' class='mention'>Alice Awesome</a>"
md.render("@{Foo Bar; foo@bar.baz}"); // => "@<a href='/my/awesome/url' class='mention hovercardable'>Foo Bar</a>"

Differences in the browser. If you load the script directly into the page, without a package system, the module will add itself globally as window.markdownitDiasporaMention.

License

MIT

You can’t perform that action at this time.