paulrobertlloyd/markdown-it-handle

Parse links to users on social networks using markdown-it.

Paul Robert Lloyd

👋 Hi, I’m Paul, an independent designer, writer and occasional speaker based in Brighton, England. I work with public sector organisations to help them design and deliver brilliant digital services.

Learn a little about me and how I like to work.

Personal projects

• Personal website, there are many like it, but this is mine.
• Indiekit, a Node.js server with all the parts needed to publish content to personal websites and share it on social networks.
• Bradshaw’s Guide, a digital revival of a Victorian favourite.
• Classnames, a source of inspiration for naming things.

Contributor

• Multipack, a community of web designers and developers in the West Midlands.
• X-GOV.UK, a collection of projects useful for those working in government, but not linked to GOV.UK in an official capacity.

markdown-it-handle's Issues

Prepare initial release

Following Cédric Aellen’s initial idea, a plugin for markdown-it that converts handles into links to user profile pages.

For example, given this Markdown:

@[e-mail], @[e-mail] and @[e-mail].

using this plugin will generate the following HTML markup (lines wrapped for clarity):

<p>
  <a href="https://micro.blog/paulrobertlloyd" rel="external">@paulrobertlloyd</a>,
  <a href="https://twitter.com/paulrobertlloyd" rel="external">@paulrobertlloyd</a> and
  <a href="https://mastodon.social/@paulrobertlloyd" rel="external">@paulrobertlloyd</a>.
</p>

Currently there are 2 options; you can change the link behaviour for given hosts (i.e Flickr username URLs don’t use the @ symbol, but are proceeded by /photos/), and the attributes used on the link (for example, class, rel, etc.) can be altered. Need to think how these are handled; do options override defaults, or get merged with them? That said, let’s not overthink this!

@alienlebarge - you’ve inspired me! Do you want to give this a try on your site (and would you like to contribute to this project?)

To do

• Consider plugin options, and how user options are combined with defaults
• Test on a website
• Add more tests
• Complete test coverage
• Documentation