fe1642e854
- Pressing gd on a module in your doom! block will now browse that module's directory. - Pressing K on a module will jump to that module's documentation, if any. - Pressing K on a module flag will jump to that flag's description within that module's documenation. - This is now explained in init.example.el Closes #2249
42 lines
No EOL
1.2 KiB
Text
42 lines
No EOL
1.2 KiB
Text
# -*- mode: snippet -*-
|
|
# name: Doom module readme
|
|
# --
|
|
#+TITLE: ${1:`(if (string-match "modules/\\([^/]+\\)/\\([^/]+\\)/.+" buffer-file-name)
|
|
(format "%s/%s"
|
|
(match-string 1 buffer-file-name)
|
|
(match-string 2 buffer-file-name))
|
|
"")`}
|
|
#+DATE: `(format (format-time-string "%B %%s, %Y") (string-to-number (format-time-string "%d")))`
|
|
#+SINCE: ${2:{replace with next tagged release version}}
|
|
#+STARTUP: inlineimages nofold
|
|
|
|
* Table of Contents :TOC_3:noexport:
|
|
|
|
* Description
|
|
${3:A summary of what this module does.}
|
|
|
|
+ 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
|
|
|
|
** Module Flags
|
|
This module provides no flags.
|
|
|
|
** Plugins
|
|
{A list of linked plugins}
|
|
|
|
** Hacks
|
|
{A list of internal modifications to included packages}
|
|
|
|
* Prerequisites
|
|
This module has no prereqisites.
|
|
|
|
* Features
|
|
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.
|
|
|
|
* Troubleshooting
|
|
Common issues and their solution, or places to look for help.
|
|
$0 |