Giter Site home page Giter Site logo

inkdrop-mark-text's Introduction

inkdrop-mark-text

Updated version of inkdrop-highlight-text

A plugin for Inkdrop that implements the Markdown text highlighting extension. It parses text enclosed by == and renders it as marked text.

Motivation

Having used Evernote in the past I really missed the ability to highlight text in Inkdrop. In contrast to strong and emphasis, marking text in that manner also conveys a different meaning as the MDN web docs nicely point out:

Don’t confuse <mark> with the <strong> element; <mark> is used to denote content which has a degree of relevance, while <strong> indicates spans of text of importance.

As people often copy text from the web into their notes and like to annotate it, you can make the case that Github Flavored Markdown is lacking in its syntax to adequately support this use case with respect to note taking.

Install

ipm install mark-text

Usage

Here is an example showcasing text highlighting in conjuction with blockquotes:

> ==To be, or not to be==, that is the question

usage example

You can add a keymapping (keyboard shortcut) that allows you to highlight selected text. Please note that it is not active by default. You have to enable it by adding a keymapping to your keymap.cson like so:

'body':
  'ctrl-m': 'mark-text:toggle'

Compatibility

Keep in mind that text highlighting is not part of the official CommonMark or Github Flavored Markdown specification. Therefore using the == syntax to highlight text might be ignored by other Markdown readers and as a result carry over to the rendered text.

Fortunately many Markdown-enabled applications support text highlighting as an experimental feature, see here, here, here and also here. Despite lacking formal specification the syntax can be considered stable at this point and is unlikely to change.

Theming support

Theme developers can use the CSS selector .mde-preview mark for styling.

Acknowledgments

  • This plugin relies on remark-mark by moyuyc
  • Special thanks to the developers of zmarkdown for general help on remark plugin development and @craftzdog for promoting the idea

inkdrop-mark-text's People

Contributors

taylantatli avatar

Stargazers

Ryan McQuen avatar

Watchers

James Cloos avatar

inkdrop-mark-text's Issues

Work on syntax editor view

Hi.
Could be possible to make this work within the syntax editor window?
I mean render this directly in the editor?

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.