Giter VIP home page Giter VIP logo

paste-markdown's Introduction

Paste Markdown objects

  • Paste spreadsheet cells and HTML tables as a Markdown tables.
  • Paste URLs on selected text as Markdown links.
  • Paste text containing links as text containing Markdown links.
  • Paste image URLs as Markdown image links.
  • Paste markdown as markdown. See @github/quote-selection/Preserving markdown syntax for details.

Installation

$ npm install @github/paste-markdown

Usage

import {subscribe} from '@github/paste-markdown'

// Subscribe the behavior to the textarea.
subscribe(document.querySelector('textarea[data-paste-markdown]'))

Using a library like selector-observer, the behavior can automatically be applied to any element matching a selector.

import {observe} from 'selector-observer'
import {subscribe} from '@github/paste-markdown'

// Subscribe the behavior to all matching textareas.
observe('textarea[data-paste-markdown]', {subscribe})

Excluding <table>s

Some <table>s are not meant to be pasted as markdown; for example, a file content table with line numbers in a column. Use data-paste-markdown-skip to prevent it.

<table data-paste-markdown-skip>
  ...
</table>

Granular control for pasting as plain text

If you're wanting more granular support of pasting certain items as plain text by default, you can pass in the controls config at the subscribe level.

Our config support looks as follows:

import {subscribe} from '@github/paste-markdown'

// Subscribe the behavior to the textarea with pasting URL links as plain text by default.
subscribe(document.querySelector('textarea[data-paste-markdown]'), {defaultPlainTextPaste: {urlLinks: true}})

In this scenario above, pasting a URL over selected text will paste as plain text by default, but pasting a table will still paste as markdown by default.

Only the urlLinks param is currently supported.

If there is no config passed in, or attributes missing, this will always default to false, being the existing behavior.

Development

npm install
npm test

License

Distributed under the MIT license. See LICENSE for details.

paste-markdown's People

Contributors

abhishek01039 avatar actions-user avatar akenneth avatar anleac avatar camertron avatar colebemis avatar danielguillan avatar dependabot[bot] avatar dgraham avatar dgreif avatar imjohnbo avatar ipc103 avatar jfuchs avatar jonrohan avatar keithamus avatar koddsson avatar manuelpuyol avatar mislav avatar muan avatar siddharthkp avatar simurai avatar sorcio avatar srt32 avatar steffen avatar theinterned avatar zutshisunakshi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.