Update links to point to preservim

This commit is contained in:
Peter Aronoff
2022-02-12 20:36:37 -05:00
parent 942e02e53c
commit 5b4110dade
4 changed files with 53 additions and 144 deletions

View File

@@ -7,7 +7,7 @@
<br/> <br/>
- - - - - -
![demo](http://i.imgur.com/0KYl5vU.gif) ![demo](https://i.imgur.com/0KYl5vU.gif)
- - - - - -
# Features # Features
@@ -73,79 +73,27 @@ tool in expressing yourself. For more details on vi-style editing, see...
* [Why Atom Cant Replace Vim, Learning the lesson of vi][wa] (March 2014) * [Why Atom Cant Replace Vim, Learning the lesson of vi][wa] (March 2014)
* [Language of Vim/Neovim][lovn] (January 2015) * [Language of Vim/Neovim][lovn] (January 2015)
[ls]: http://yanpritzker.com/2011/12/16/learn-to-speak-vim-verbs-nouns-and-modifiers/ [ls]: https://yanpritzker.com/2011/12/16/learn-to-speak-vim-verbs-nouns-and-modifiers/
[gv]: http://stackoverflow.com/questions/1218390/what-is-your-most-productive-shortcut-with-vim/1220118#1220118 [gv]: https://stackoverflow.com/a/1220118/
[ig]: http://takac.github.io/2013/01/30/vim-grammar/ [ig]: https://takac.github.io/2013/01/30/vim-grammar/
[wa]: https://medium.com/p/433852f4b4d1 [wa]: https://medium.com/p/433852f4b4d1
[lovn]: https://allsyed.com/posts/language-of-vim-neovim/ [lovn]: https://allsyed.com/posts/language-of-vim-neovim/
# Installation # Installation
_pencil_ is best installed using a Vim package manager, such as You can install using your favorite Vim package manager. (E.g.,
[Vundle][vnd], [Plug][plg], [NeoBundle][nbn], or [Pathogen][pth]. [Pathogen][pathogen], [Vundle][vundle], or [Plug][plug].) If you are using
a recent version of vim or neovim, you can also use native package
support. (See [:help packages][packages].)
_For those new to Vim: before installing this plugin, consider getting _For those new to Vim: before installing this plugin, consider getting
comfortable with the basics of Vim by working through one of the many comfortable with the basics of Vim by working through one of the many
tutorials available._ tutorials available._
[vnd]: https://github.com/gmarik/Vundle.vim [pathogen]: https://github.com/tpope/vim-pathogen
[plg]: https://github.com/junegunn/vim-plug [vundle]: https://github.com/VundleVim/Vundle.vim
[nbn]: https://github.com/Shougo/neobundle.vim [plug]: https://github.com/junegunn/vim-plug
[pth]: https://github.com/tpope/vim-pathogen [packages]: https://vimhelp.org/repeat.txt.html#packages
#### Vundle
Add to your `.vimrc` and save:
```vim
Plugin 'reedes/vim-pencil'
```
…then run the following in Vim:
```vim
:source %
:PluginInstall
```
#### Plug
Add to your `.vimrc` and save:
```vim
Plug 'reedes/vim-pencil'
```
…then run the following in Vim:
```vim
:source %
:PlugInstall
```
#### NeoBundle
Add to your `.vimrc` and save:
```vim
NeoBundle 'reedes/vim-pencil'
```
…then run the following in Vim:
```vim
:source %
:NeoBundleInstall
```
#### Pathogen
Run the following in a terminal:
```bash
cd ~/.vim/bundle
git clone https://github.com/reedes/vim-pencil
```
# Configuration # Configuration
@@ -367,7 +315,7 @@ To use Vims Conceal feature with Markdown, you will need to install:
2. A monospaced font (such as [Cousine][co]) featuring the _italic_, 2. A monospaced font (such as [Cousine][co]) featuring the _italic_,
**bold**, and ***bold italic*** style variant for styled text. **bold**, and ***bold italic*** style variant for styled text.
3. A colorscheme (such as [reedes/vim-colors-pencil][cp]) which supports 3. A colorscheme (such as [preservim/vim-colors-pencil][cp]) which supports
the Markdown-specific highlight groups for styled text. the Markdown-specific highlight groups for styled text.
You should then only see the `_` and `*` markup for the cursor line and in You should then only see the `_` and `*` markup for the cursor line and in
@@ -376,8 +324,8 @@ visual selections.
**Terminal users:** consult your terminals documentation to configure your **Terminal users:** consult your terminals documentation to configure your
terminal to support **bold** and _italic_ styles. terminal to support **bold** and _italic_ styles.
[co]: http://www.google.com/fonts/specimen/Cousine [co]: https://fonts.google.com/specimen/Cousine
[tm]: http://github.com/tpope/vim-markdown [tm]: https://github.com/tpope/vim-markdown
## Status line indicator ## Status line indicator
@@ -416,7 +364,7 @@ your `.vimrc`.
Note that `PencilMode()` will return blank for buffers in which _pencil_ Note that `PencilMode()` will return blank for buffers in which _pencil_
has not been initialized. has not been initialized.
[va]: http://github.com/bling/vim-airline [va]: https://github.com/bling/vim-airline
## Advanced pencil ## Advanced pencil
@@ -646,16 +594,16 @@ Other plugins of specific interest to writers:
* [junegunn/goyo.vim][jg] - distraction-free editing mode * [junegunn/goyo.vim][jg] - distraction-free editing mode
[vd]: https://github.com/danielbmarques/vim-ditto [vd]: https://github.com/danielbmarques/vim-ditto
[qtfwp]: http://benoliver999.com/technology/2014/12/06/vimforprose/ [qtfwp]: https://benoliver999.com/technology/2014/12/06/vimforprose/
[vic]: https://labs.tomasino.org/vim-in-context/ [vic]: https://labs.tomasino.org/vim-in-context/
[rewp]: https://medium.com/usevim/reed-esaus-writing-plugins-5b6c65bc808f [rewp]: https://medium.com/usevim/reed-esaus-writing-plugins-5b6c65bc808f
[tviai]: https://www.safaribooksonline.com/blog/2014/11/23/way-vim-ide/ [tviai]: https://www.safaribooksonline.com/blog/2014/11/23/way-vim-ide/
[regl]: http://wynnnetherland.com/journal/reed-esau-s-growing-list-of-vim-plugins-for-writers/ [regl]: http://wynnnetherland.com/journal/reed-esau-s-growing-list-of-vim-plugins-for-writers/
[dfwiv]: http://tlattimore.com/blog/distraction-free-writing-in-vim/ [dfwiv]: http://tlattimore.com/blog/distraction-free-writing-in-vim/
[ab]: http://github.com/tpope/vim-abolish [ab]: https://github.com/tpope/vim-abolish
[ex]: http://github.com/tommcdo/vim-exchange [ex]: https://github.com/tommcdo/vim-exchange
[jl]: http://github.com/junegunn/limelight.vim [jl]: https://github.com/junegunn/limelight.vim
[jg]: http://github.com/junegunn/goyo.vim [jg]: https://github.com/junegunn/goyo.vim
Markdown syntax plugins Markdown syntax plugins
@@ -671,24 +619,24 @@ Those using tables and footnotes should consider installing this plugin:
Alternatives to Tim Popes syntax highlighting include: Alternatives to Tim Popes syntax highlighting include:
* [plasticboy/vim-markdown][pvm] * [preservim/vim-markdown][pvm]
* [gabrielelana/vim-markdown][gvm] * [gabrielelana/vim-markdown][gvm]
Note that the plasticboy and gabrielelana plugins may incorrectly Note that the plasticboy and gabrielelana plugins may incorrectly
reformat bulleted lists when Vims autoformat is active in _pencil_s reformat bulleted lists when Vims autoformat is active in _pencil_s
HardPencil mode. HardPencil mode.
[tvm]: http://github.com/tpope/vim-markdown [tvm]: https://github.com/tpope/vim-markdown
[pvm]: http://github.com/plasticboy/vim-markdown [pvm]: https://github.com/preservim/vim-markdown
[gvm]: http://github.com/gabrielelana/vim-markdown [gvm]: https://github.com/gabrielelana/vim-markdown
[mvme]: http://github.com/mattly/vim-markdown-enhancements [mvme]: https://github.com/mattly/vim-markdown-enhancements
If you find the _pencil_ plugin useful, check out these others by [@reedes][re]: If you find the _pencil_ plugin useful, check out these others originally
by [@reedes][re]:
* [vim-colors-pencil][cp] - color scheme for Vim inspired by IA Writer * [vim-colors-pencil][cp] - color scheme for Vim inspired by IA Writer
* [vim-lexical][lx] - building on Vims spell-check and thesaurus/dictionary completion * [vim-lexical][lx] - building on Vims spell-check and thesaurus/dictionary completion
* [vim-litecorrect][lc] - lightweight auto-correction for Vim * [vim-litecorrect][lc] - lightweight auto-correction for Vim
* [vim-one][vo] - make use of Vims _+clientserver_ capabilities
* [vim-textobj-quote][qu] - extends Vim to support typographic (curly) quotes * [vim-textobj-quote][qu] - extends Vim to support typographic (curly) quotes
* [vim-textobj-sentence][ts] - improving on Vims native sentence motion command * [vim-textobj-sentence][ts] - improving on Vims native sentence motion command
* [vim-thematic][th] - modify Vims appearance to suit your task and environment * [vim-thematic][th] - modify Vims appearance to suit your task and environment
@@ -699,25 +647,29 @@ If you find the _pencil_ plugin useful, check out these others by [@reedes][re]:
Unimpressed by _pencil_? [vim-pandoc][vp] offers prose-oriented features Unimpressed by _pencil_? [vim-pandoc][vp] offers prose-oriented features
with its own Markdown variant. with its own Markdown variant.
[cp]: http://github.com/reedes/vim-colors-pencil [cp]: https://github.com/preservim/vim-colors-pencil
[lc]: http://github.com/reedes/vim-litecorrect [lc]: https://github.com/preservim/vim-litecorrect
[lx]: http://github.com/reedes/vim-lexical [lx]: https://github.com/preservim/vim-lexical
[qu]: http://github.com/reedes/vim-textobj-quote [qu]: https://github.com/preservim/vim-textobj-quote
[re]: http://github.com/reedes [re]: https://github.com/reedes
[tc]: https://www.youtube.com/watch?v=Nim4_f5QUxA [tc]: https://www.youtube.com/watch?v=Nim4_f5QUxA
[th]: http://github.com/reedes/vim-thematic [th]: https://github.com/preservim/vim-thematic
[ts]: http://github.com/reedes/vim-textobj-sentence [ts]: https://github.com/preservim/vim-textobj-sentence
[tv]: http://ianhocking.com/2013/11/17/to-vim/ [tv]: https://ianhocking.com/2013/11/17/to-vim/
[vo]: http://github.com/reedes/vim-one [vo]: https://github.com/preservim/vim-one
[vw]: http://therandymon.com/woodnotes/vim-for-writers/vimforwriters.html [vw]: https://therandymon.com/woodnotes/vim-for-writers/vimforwriters.html
[wh]: http://github.com/reedes/vim-wheel [wh]: https://github.com/preservim/vim-wheel
[wo]: http://github.com/reedes/vim-wordy [wo]: https://github.com/preservim/vim-wordy
[wc]: http://github.com/reedes/vim-wordchipper [wc]: https://github.com/preservim/vim-wordchipper
[vp]: http://github.com/vim-pandoc/vim-pandoc [vp]: https://github.com/vim-pandoc/vim-pandoc
# Future development # Future development
If youve spotted a problem or have an idea on improving _pencil_, please If youve spotted a problem or have an idea on improving _pencil_, please
report it as an issue, or better yet submit a pull request. report it [as an issue][issues], or better yet submit [a pull
request][pull-request].
[issues]: https://github.com/preservim/vim-pencil/issues
[pull-request]: https://github.com/preservim/vim-pencil/pulls
<!-- vim: set tw=73 :--> <!-- vim: set tw=73 :-->

View File

@@ -1,7 +1,7 @@
" ============================================================================ " ============================================================================
" File: pencil.vim " File: pencil.vim
" Description: autoload functions for vim-pencil plugin " Description: autoload functions for vim-pencil plugin
" Maintainer: Reed Esau <github.com/reedes> " Maintainer: preservim <https://github.com/preservim>
" Created: December 28, 2013 " Created: December 28, 2013
" License: The MIT License (MIT) " License: The MIT License (MIT)
" ============================================================================ " ============================================================================

View File

@@ -120,51 +120,8 @@ For more details on vi-style editing, see...
4. Installation *vim-pencil-initialize* 4. Installation *vim-pencil-initialize*
pencil is best installed using a Vim package manager, such as Vundle, Plug, pencil is best installed using a Vim package manager, such as Vundle, Plug,
NeoBundle, or Pathogen. NeoBundle, or Pathogen. If you are using a recent version of vim or neovim,
you can also use native package support. (See |packages|.)
For those new to Vim: before installing this plugin, consider getting
comfortable with the basics of Vim by working through one of the many
tutorials available.
Vundle:
Add to your .vimrc and save:
Plugin 'reedes/vim-pencil'
…then run the following in Vim:
:source %
:PluginInstall
Plug:
Add to your .vimrc and save:
Plug 'reedes/vim-pencil'
…then run the following in Vim:
:source %
:PlugInstall
NeoBundle:
Add to your .vimrc and save:
NeoBundle 'reedes/vim-pencil'
…then run the following in Vim:
:source %
:NeoBundleInstall
Pathogen:
Run the following in a terminal:
cd ~/.vim/bundle
git clone https://github.com/reedes/vim-pencil
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
4.1. Initializing by command *vim-pencil-init-by-command* 4.1. Initializing by command *vim-pencil-init-by-command*
@@ -610,12 +567,12 @@ Detect via sampling
If youve spotted a problem or have an idea on improving pencil, please report If youve spotted a problem or have an idea on improving pencil, please report
it as an issue, or better yet submit a pull request. it as an issue, or better yet submit a pull request.
See https://github.com/reedes/vim-pencil for details See https://github.com/preservim/vim-pencil for details
============================================================================== ==============================================================================
17. Development *vim-pencil-development* 17. Development *vim-pencil-development*
Github: https://github.com/reedes/vim-pencil Github: https://github.com/preservim/vim-pencil
For Contributors and their Github usernames please see the github repository For Contributors and their Github usernames please see the github repository

View File

@@ -1,7 +1,7 @@
" ============================================================================ " ============================================================================
" File: pencil.vim " File: pencil.vim
" Description: vim-pencil plugin " Description: vim-pencil plugin
" Maintainer: Reed Esau <github.com/reedes> " Maintainer: preservim <https://github.com/preservim>
" Created: December 28, 2013 " Created: December 28, 2013
" License: The MIT License (MIT) " License: The MIT License (MIT)
" ============================================================================ " ============================================================================