doc fixes
This commit is contained in:
parent
5038781428
commit
701c449f64
|
@ -203,7 +203,7 @@ In the files header, change the default author name (=Sylvain Benner=) to your
|
|||
name.
|
||||
|
||||
**** README.org tags
|
||||
Every README.org file of a layer should contain =#+TAGS:= line:
|
||||
Every README.org file of a layer should have =#+TAGS:= line:
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
#+TITLE: My layer
|
||||
|
@ -214,9 +214,9 @@ Every README.org file of a layer should contain =#+TAGS:= line:
|
|||
...
|
||||
#+END_EXAMPLE
|
||||
|
||||
Individual tags are separated with "|" char.
|
||||
Example above contains 2 tags: "layer" and "web service"
|
||||
Tags are listed in [[https://github.com/syl20bnr/spacemacs/blob/develop/.ci/spacedoc-cfg.edn][=<spacemacs_root>/.ci/spacedoc-cfg.edn=]]
|
||||
Individual tags are separated with "|" character.
|
||||
Example above has 2 tags: "layer" and "web service".
|
||||
Tags are listed in [[https://github.com/syl20bnr/spacemacs/blob/develop/.ci/spacedoc-cfg.edn][<spacemacs_root>/.ci/spacedoc-cfg.edn]] configuration file.
|
||||
|
||||
#+BEGIN_SRC clojure
|
||||
:spacetools.spacedoc.config/valid-tags
|
||||
|
@ -227,29 +227,24 @@ Tags are listed in [[https://github.com/syl20bnr/spacemacs/blob/develop/.ci/spac
|
|||
"completion" "Completion"}
|
||||
#+END_SRC
|
||||
|
||||
Labels are used to name headlines in =LAYERS.org= file and
|
||||
=:spacetools.spacedoc.config/layers-org-query= defines its structure by
|
||||
Labels are used to name headlines in [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/LAYERS.org][LAYERS.org]] file and
|
||||
[[https://github.com/syl20bnr/spacemacs/blob/develop/.ci/spacedoc-cfg.edn][:spacetools.spacedoc.config/layers-org-query]] defines structure of the file by
|
||||
chaining tags into a tree where every leaf turns into a list of
|
||||
descriptions pulled out of README.org files that match leaf's path in the tree.
|
||||
You can see how the shape of [[https://github.com/syl20bnr/spacemacs/blob/develop/.ci/spacedoc-cfg.edn][=<spacemacs_root>/.ci/spacedoc-cfg.edn=]]
|
||||
descriptions pulled out of README.org files which tags match leaf's path in the tree.
|
||||
You can see how the shape of [[https://github.com/syl20bnr/spacemacs/blob/develop/.ci/spacedoc-cfg.edn][<spacemacs_root>/.ci/spacedoc-cfg.edn]]
|
||||
repeats in [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/LAYERS.org#table-of-contents][TOC of LAYERS.org]].
|
||||
There is one really useful property - every layer description
|
||||
will be displayed only once. It is used for "catch all" sections to
|
||||
match layers which do not have precise grouping.
|
||||
For example DSL language layers:
|
||||
|
||||
#+BEGIN_SRC clojure
|
||||
{"programming" [{"dsl" ["lisp"
|
||||
"markup"
|
||||
"script"
|
||||
]}
|
||||
"dsl"]}
|
||||
Every layer description will be displayed only once.
|
||||
|
||||
If you want to experiment with the system locally:
|
||||
|
||||
#+BEGIN_SRC shell
|
||||
docker run --rm \
|
||||
-v <SPACEMACS_REPO_ROOT>:/tmp/docs \
|
||||
-v <PATH_TO_CONFIG_FILE>:/opt/spacetools/spacedoc-cfg.edn \
|
||||
jare/spacetools docfmt /tmp/docs/
|
||||
#+END_SRC
|
||||
|
||||
Here every layer that has tags: "layer", "programming", "dsl" plus one of
|
||||
"lisp", "markup", "script" tags will be displayed first then the rest of
|
||||
layers that have "layer", "programming", "dsl" tags.
|
||||
|
||||
*** Contributor to an existing layer
|
||||
If you are contributing to an already existing layer, you should not modify any
|
||||
header file.
|
||||
|
|
|
@ -3,13 +3,6 @@
|
|||
#+TAGS: framework|layer|programming
|
||||
|
||||
* Table of Contents :TOC_5_gh:noexport:
|
||||
- [[#table-of-contents][Table of Contents]]
|
||||
- [[#description][Description]]
|
||||
- [[#features][Features:]]
|
||||
- [[#install][Install]]
|
||||
- [[#key-bindings][Key bindings]]
|
||||
|
||||
* Table of Contents
|
||||
- [[#description][Description]]
|
||||
- [[#features][Features:]]
|
||||
- [[#install][Install]]
|
||||
|
|
|
@ -133,8 +133,7 @@ where =0.7.6= can be replaced with the current version of [[https://github.com/s
|
|||
#+END_SRC
|
||||
|
||||
You will then have the common LSP key bindings; see
|
||||
[[http://develop.spacemacs.org/layers/+tools/lsp/README.html#key-bindings]] for more
|
||||
details.
|
||||
[[https://github.com/syl20bnr/spacemacs/tree/develop/layers/%2Btools/lsp#key-bindings][LSP#key-bindings]] for more details.
|
||||
|
||||
* Scalastyle
|
||||
[[http://www.scalastyle.org/][Scalastyle]] provides style-checking and linting. The Emacs functionality is
|
||||
|
|
Loading…
Reference in New Issue