4

Vim helpfiles cheatsheet

 2 years ago
source link: https://devhints.io/vim-help
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
Vim helpfiles cheatsheet

Creating a document

:e doc/potion.txt
:set ft=help
:set ft=text

Use ft=help to preview it, and ft=text to edit it.

Example

*ack.txt*   Plugin that integrates ack with Vim

==============================================================================
USAGE INSTRUCTIONS                                                 *ack-usage*

:Ack[!] {pattern}                                                       *:Ack*

    Search recursively for {pattern}. See |:AckAdd|.
    Also see http://beyondgrep.com for more information.

vim:tw=78:ts=8:ft=help:norl:

This is a cheatsheet for writing Vim help files. See: :help help-writing

#Syntax

Reference

Inline items     *tags* Tags   |link-to-tags| Links to tags |:command| 'vimoption' Vim option 'textwidth' {code-text} Code text {Visual}gf <code-text> Code text <PageDown> `code-text` Code text `set fo=want` CTRL-X Code text   Block items     INTRODUCTION *tag* Section header   Column heading~ Highlighting   www.url.com Web URL   ===== Separator   ----- Separator  
  • Tags are created with asterisks, eg, *potion-usage*
  • Links to tags are |potion-usage|
  • Press ^] to jump to a tag

Code blocks

Example: >
 xyz
<

Surround with > and < characters

File header

*potion.txt*  functionality for the potion programming language

It’s customary to start a file with a tag of the filename, plus a description.

Heading

==============================================================================
CONTENTS                                                     *potion-contents*

Starts with ALL CAPS, ends with *a-tag*

Notes

Using *Todo and *Error will highlight your notes.

	*Todo something to do
	*Error something wrong

Final modeline

vim:tw=78:ts=8:ft=help:norl:

#Conventions

Table of contents

|rails-introduction|            Introduction and Feature Summary
|rails-commands|                General Commands
|rails-navigation|              Navigation

    1.Intro...................................|ergonomic|
    2.Note to use..............................|CAPSLOCK|
    3.Insert Mode Remappings............|ergonomicInsert|

Author lines

Author:  Jack Hackness <[email protected]>         *xyz-author*
License: Same terms as Vim itself (see |license|)

report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK