spacemacs/core/templates
Eivind Fonn e61e915555 Revise .spacemacs docstrings
This is an attempt to tighten up the language of the docstrings for
initialization and configuration functions. I realize that's pretty
subjective, so please only use what makes sense. Below is a break-
down to avoid seeming _too_ arbitrary.

Rationale
---------
Headings: We know they're functions, so we don't need to say
'X function'. 'Layer configuration' is called that in the other
functions.

Instructions: Say what I should do.

Other: `dotspacemacs/init' -- 'very beginning' is the more common
English idiom.

If I sound strident, it's just 'cause I'm trying to be terse.
This is all opinion so YMMV. I hope it helps.
2017-06-07 12:58:06 +02:00
..
.spacemacs.template Revise .spacemacs docstrings 2017-06-07 12:58:06 +02:00
packages.el.template Bump year in copyright headers 2017-01-05 23:08:17 -05:00
README.org.template
REPORTING.template

#+TITLE: %LAYER_NAME% layer

# The maximum height of the logo should be 200 pixels.
[[img/%LAYER_NAME%.png]]

# TOC links should be GitHub style anchors.
* Table of Contents                                        :TOC_4_gh:noexport:
 - [[#decsription][Description]]
 - [[#install][Install]]
 - [[#key-bindings][Key bindings]]

* Description
This layer does wonderful things:
  - thing01

* Install
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =%LAYER_NAME%= to the existing =dotspacemacs-configuration-layers= list in this
file.

* Key bindings

| Key Binding | Description    |
|-------------+----------------|
| ~SPC x x x~ | Does thing01   |
# Use GitHub URLs if you wish to link a Spacemacs documentation file or its heading.
# Examples:
# [[https://github.com/syl20bnr/spacemacs/blob/master/doc/VIMUSERS.org#sessions]]
# [[https://github.com/syl20bnr/spacemacs/blob/master/layers/%2Bfun/emoji/README.org][Link to Emoji layer README.org]]
# If space-doc-mode is enabled, Spacemacs will open a local copy of the linked file.