GithubHelp home page GithubHelp logo

inkdrop-marks's Introduction

Marks Navigation for Inkdrop

A plugin that lets you add marks to help navigate long notes. Marks are intended for jumping in-and-out of areas of interest. They're less formal than headings, and intended to be used between paragraphs, or even sentences.

Install

ipm install marks

Usage

Bold some text and append an emphasized colon. ie. ** About marks*:* **

Example:

Let's see how we can add marks in the middle of a paragraph. ** About marks*:* ** Every mark has a title, and won't be rendered when viewed in Inkdrop. The title will shown in the marks menu.

The abstract syntax allows for graceful fallback: if your note is ever rendered in another markdown renderer seeing a mark shouldn't be too out of place for the reader.

To bring up the marks in your note, use the marks:show command. Then click on a mark to navigate to its location.

Shortcuts

Action Mac Windows Linux
Show Marks Menu cmd + m ctrl + m ctrl + m

Roadmap

Possible features to be implemented in no particular order:

  • Shortcut to jump to a specific mark (ie. ctrl + m + 3 + <CR> to go to the 3rd mark)
  • Shortcut to jump back to previous location
  • Snippet to insert mark

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.