11 ### Creating a document
19 Use `ft=help` to preview it, and `ft=text` to edit it.
24 *ack.txt* Plugin that integrates ack with Vim
26 ==============================================================================
27 USAGE INSTRUCTIONS *ack-usage*
29 :Ack[!] {pattern} *:Ack*
31 Search recursively for {pattern}. See |:AckAdd|.
32 Also see http://beyondgrep.com for more information.
34 vim:tw=78:ts=8:ft=help:norl:
37 This is a cheatsheet for writing Vim help files. See: `:help help-writing`
43 | Code | Description | Example |
44 | ----- | ----- | ----- |
46 | ----- | ----- | ----- |
48 | `|link-to-tags|` | Links to tags | `|:command|` |
49 | `'vimoption'` | Vim option | `'textwidth'` |
50 | ----- | ----- | ----- |
51 | `{code-text}` | Code text | `{Visual}gf` |
52 | `<code-text>` | Code text | `<PageDown>` |
53 | `` `code-text` `` | Code text | `` `set fo=want` `` |
54 | `CTRL-X` | Code text | |
55 | ----- | ----- | ----- |
57 | ----- | ----- | ----- |
58 | `INTRODUCTION *tag*` | Section header | |
59 | `Column heading~` | Highlighting | |
60 | `www.url.com` | Web URL | |
61 | ----- | ----- | ----- |
62 | `=====` | Separator | |
63 | `-----` | Separator | |
67 * Tags are created with asterisks, eg, `*potion-usage*`
68 * Links to tags are `|potion-usage|`
69 * Press `^]` to jump to a tag
79 Surround with `>` and `<` characters
84 *potion.txt* functionality for the potion programming language
87 It's customary to start a file with a tag of the filename, plus a description.
92 ==============================================================================
93 CONTENTS *potion-contents*
96 Starts with `ALL CAPS`, ends with `*a-tag*`
99 Using `*Todo` and `*Error` will highlight your notes.
102 *Todo something to do
103 *Error something wrong
109 vim:tw=78:ts=8:ft=help:norl:
114 ### Table of contents
117 |rails-introduction| Introduction and Feature Summary
118 |rails-commands| General Commands
119 |rails-navigation| Navigation
123 1.Intro...................................|ergonomic|
124 2.Note to use..............................|CAPSLOCK|
125 3.Insert Mode Remappings............|ergonomicInsert|
131 Author: Jack Hackness <captain@time.com> *xyz-author*
132 License: Same terms as Vim itself (see |license|)