feature/file-templates: revise doom module README.org file template
This commit is contained in:
parent
b806ff937c
commit
e8653d0628
1 changed files with 8 additions and 5 deletions
|
@ -11,10 +11,9 @@ ${2:A short summary about what this module does.}
|
|||
|
||||
${3:If necessary, include a longer description below it that goes into more detail. This may be as long as you like.
|
||||
|
||||
+ If possible, include a list of features
|
||||
+ Include links to major plugins that the module uses, if applicable
|
||||
+ Use links whenever you can
|
||||
+ Mention dependencies on other modules here}
|
||||
+ If possible, include a brief list of feature highlights here
|
||||
+ Like code completion, syntax checking or available snippets
|
||||
+ Include links to packages & external things where possible
|
||||
|
||||
* Table of Contents :TOC:
|
||||
|
||||
|
@ -25,11 +24,15 @@ This module provides no flags.
|
|||
This module has no prereqisites.
|
||||
|
||||
* Features
|
||||
A list of features, how to use them, and their dependencies.
|
||||
An in-depth list of features, how to use them, and their dependencies.
|
||||
|
||||
* Configuration
|
||||
How to configure this module, including common problems and how to address them.
|
||||
|
||||
* Appendix
|
||||
** Commands
|
||||
+ A list or table of public commands (and their keybinds) and functions that this module exposes.
|
||||
+ A brief description of how to use them
|
||||
** Hacks
|
||||
+ Include a list of ways this module changes default behavior
|
||||
$0
|
Loading…
Add table
Add a link
Reference in a new issue