Skip to main content

Getting started

Install​

npm install docusaurus-plugin-share-selection

Register the plugin​

export default {
  plugins: ['docusaurus-plugin-share-selection'],
};

That's enough. Highlight three or more words on a docs page, blog post, or MDXMDXA Markdown-based format that lets you write JSX inside your markdown, used by Docusaurus v3 for docs and pages. page and the palette appears with Copy, Ask AI, and, on phones and tablets, Share.

Selections inside code blocks are ignored, because code blocks already have a copy button.

Copy a passage, then open the link from the clipboard in a new tab. The page scrolls to the passage and highlights it.

Track what gets shared​

Every action fires a share-selection event on window:

window.addEventListener('share-selection', (event) => {
  const { action, text, link, title } = event.detail;
  analytics.track('Passage shared', { action, title });
});

Which passages readers quote, and which they ask AI to explain, tells you what's valuable and what's confusing.