sponsor Vim development Vim logo Vim Book Ad

MarkdowneyJr : Format Markdown files with simple keystrokes.

 script karma  Rating -1/1, Downloaded by 89  Comments, bugs, improvements  Vim wiki

created by
boson joe
 
script type
utility
 
description
Hi!

My name is Markdowney Jr, nice to meet you! I am a Vim plugin that makes editing markdown files easy using simple keystrokes. Depending on the formatting option, I can do transformations on visual selection, line range or motion (like 3wd, for example) or combinations of those. Hit a keystroke once - and transformation is made. If you then hit the same keystroke once or multiple times again, I will toggle through options for a particular transformation and change the text accordingly. For example, if you select a word and hit a keystroke responsible for emphasis multiple times, I will make selected text cursive, bold and then both, and once again, toggling between the options. Please refer to the User Guide to see how we can interact - https://github.com/boson-joe/markdowneyJR/wiki/MarkdowneyJr-User-Guide.

There is no need to set remaps for all the formatting options - you can define just two remaps in your vimrc, and I will take care of the rest. In case you don't want to set any remaps at all, I can give you default ones. You can also remap any or all formatting options to your liking. To see how you can set remaps and customize your experience please refer to the Customization Guide - https://github.com/boson-joe/markdowneyJR/wiki/MarkdowneyJr-Customization-Guide.

At the moment I can handle basic basic markdown syntax for you, but if you write my devs, they would be happy to introduce more features.
 
install details
To make sure the plugin works properly, we suggest you to check that your Vim has version 8.2 or higher (:echo v:version >= 802 should print out 1).


Manual

You can install the plugin by simply putting the files of the plugin in plugin/ directory in your .vim/ directory. One of the commands that could be used is wget. Type this in your terminal:

    wget https://github.com/boson-joe/markdowneyJR/blob/master/plugin/markdowneyjr.vim

To have documentation, do the same with files in doc/ directory - you need to put them into doc/ directory in your .vim/ directory.


Plugin manager

You may find plugin managers convenient to install and manage plugins you want in your Vim, including MarkdowneyJr.

vim-plug

If you are using vim-plug plugin manager, refer to their manual here - https://github.com/junegunn/vim-plug#usage

Vundle

If you are using Vundle plugin manager, refer to their manual here - https://github.com/VundleVim/Vundle.vim#quick-start.

Pathogen

If you are using Pathogen plugin manager, refer to their manual here - https://github.com/tpope/vim-pathogen#installation.
 

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
markdowneyjr.tar.xz 1.1.0 2021-09-27 8.2 boson joe markdowneyjr (v. 1.1.0), with documentation and license.
markdowneyjr.vim 1.1.0 2021-09-27 8.2 boson joe Added integration with YANP plugin - https://www.vim.org/scripts/script.php?script_id=5982
markdowneyjr.tar.xz 1.0.0 2021-08-10 8.2 boson joe markdowneyjr (v. 1.0.0), with documentation and license.
markdowneyjr.vim 1.0.0 2021-08-10 8.2 boson joe Initial upload
ip used for rating: 3.238.204.31

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
   
OSDN