2016-01-08 09:22:37 +00:00
|
|
|
#+TITLE: %LAYER_NAME% layer
|
2019-05-20 11:49:34 +00:00
|
|
|
# Document tags are separated with "|" char
|
|
|
|
|
# The example below contains 2 tags: "layer" and "web service"
|
|
|
|
|
# Avaliable tags are listed in <spacemacs_root>/.ci/spacedoc-cfg.edn
|
|
|
|
|
# under ":spacetools.spacedoc.config/valid-tags" section.
|
2019-04-21 19:00:24 +00:00
|
|
|
#+TAGS: layer|web service
|
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.
|
2016-01-08 09:22:37 +00:00
|
|
|
[[img/%LAYER_NAME%.png]]
|
2014-12-25 20:25:10 +00:00
|
|
|
|
2016-04-05 18:28:24 +00:00
|
|
|
# TOC links should be GitHub style anchors.
|
2016-03-28 06:13:55 +00:00
|
|
|
* Table of Contents :TOC_4_gh:noexport:
|
2017-07-16 16:37:37 +00:00
|
|
|
- [[#description][Description]]
|
|
|
|
|
- [[#features][Features:]]
|
|
|
|
|
- [[#install][Install]]
|
|
|
|
|
- [[#key-bindings][Key bindings]]
|
2014-12-25 20:25:10 +00:00
|
|
|
|
2015-11-04 19:05:37 +00:00
|
|
|
* Description
|
2017-07-16 16:37:37 +00:00
|
|
|
This layer adds support for something.
|
|
|
|
|
|
|
|
|
|
** Features:
|
|
|
|
|
- Autocomplete
|
2017-08-02 17:35:12 +00:00
|
|
|
- Lint
|
|
|
|
|
- Refactor
|
2017-07-16 16:37:37 +00:00
|
|
|
- ...
|
2014-12-25 20:25:10 +00:00
|
|
|
|
2015-11-04 19:05:37 +00:00
|
|
|
* Install
|
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.
|
2014-12-25 20:25:10 +00:00
|
|
|
|
2015-11-04 19:05:37 +00:00
|
|
|
* Key bindings
|
2015-06-10 17:40:51 +00:00
|
|
|
|
2016-03-20 00:35:39 +00:00
|
|
|
| Key Binding | Description |
|
|
|
|
|
|-------------+----------------|
|
|
|
|
|
| ~SPC x x x~ | Does thing01 |
|
2017-07-16 16:37:37 +00:00
|
|
|
|
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.
|
