spacemacs/core/templates/README.org.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.
Update packages.el template - Remove extensions template - Prompt before creating readme (Users creating private layers probably don't want to create a readme) - Template out layer author and email address - Rename LAYERNAME to LAYER_NAME for readability - Use fallback attributes if user-full-name is unset - Fix inconsistent Spacemacs capitalization in template 2016-01-08 09:22:37 +00:00			`#+TITLE: %LAYER_NAME% layer`
Add a templare for layer README 2014-12-25 20:25:10 +00:00
Refactor CONTRIBUTING documentations This commit merge the `CONTRIBUTING.md` and `doc/CONTRIBUTE.org` file into a new `CONTRIBUTING.org` file. It also refactors the content to be more organized and make its navigation more goal-oriented. Github displays a link to the `CONTRIBUTING.` file when people are opening new issues or proposing new PRs. This file is important because it is the entry-point to contributions guidelines for most of the users. The current setup is non-optimal, even broken, as it adds a level of indirection, and points to a contributing file that has broken links (due to the new documentation format). The possible drawback of the proposed solution is that I'm not sure if it is possible to include it into the new online documentation as it is not in `doc/` folder. The other possibility is to keep a small `CONTRIBUTING.md` file, as it is now, pointing to the new documentation system (once online), but I'm preferring the proposed solution for the following reasons: - People that are willing to contribute will probably open Github first (for forking, creating PR, etc), not the online documentation. - It has one level of indirection less when people click on the guidelines guide from a new issue/PR. - `CONTRIBUTING.` is by convention a special kind of file on github, so it's valid reason to break the rule and not having it in the `doc/` folder. 2015-11-22 13:11:08 +00:00			`# The maximum height of the logo should be 200 pixels.`
Update packages.el template - Remove extensions template - Prompt before creating readme (Users creating private layers probably don't want to create a readme) - Template out layer author and email address - Rename LAYERNAME to LAYER_NAME for readability - Use fallback attributes if user-full-name is unset - Fix inconsistent Spacemacs capitalization in template 2016-01-08 09:22:37 +00:00			`[[img/%LAYER_NAME%.png]]`
Add a templare for layer README 2014-12-25 20:25:10 +00:00
Add space-doc link examples to README.org.template 2016-04-05 18:28:24 +00:00			`# TOC links should be GitHub style anchors.`
update README.org.template to the new convention Remove #+HTML_HEAD_EXTRA: <link ... /readtheorg.css" /> :TOC_4_org:noexport: -> :TOC_4_gh:noexport: 2016-03-28 06:13:55 +00:00			`* Table of Contents :TOC_4_gh:noexport:`
			`- [[#decsription][Description]]`
			`- [[#install][Install]]`
			`- [[#key-bindings][Key bindings]]`
Add a templare for layer README 2014-12-25 20:25:10 +00:00
Update layer README template With respect to the recent documentation changes 2015-11-04 19:05:37 +00:00			`* Description`
Add spacing conventions for writing documentation. These were briefly discussed in #2124. 2015-07-25 05:33:04 +00:00			`This layer does wonderful things:`
			`- thing01`
Add a templare for layer README 2014-12-25 20:25:10 +00:00
Update layer README template With respect to the recent documentation changes 2015-11-04 19:05:37 +00:00			`* Install`
Update README.org template for layers 2016-03-22 00:04:38 +00:00			`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.`
Add a templare for layer README 2014-12-25 20:25:10 +00:00
Update layer README template With respect to the recent documentation changes 2015-11-04 19:05:37 +00:00			`* Key bindings`
Update layer-README.template to org. 2015-06-10 17:40:51 +00:00
Fix inconsistent notation of SPC key in docs Replace all occurrences of <SPC> in org files with SPC. Fixes syl20bnr/spacemacs#1823 2016-03-20 00:35:39 +00:00			`\| Key Binding \| Description \|`
			`\|-------------+----------------\|`
			`\| ~SPC x x x~ \| Does thing01 \|`
Add space-doc link examples to README.org.template 2016-04-05 18:28:24 +00:00			`# 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.`