documentation formatting: Sun Feb 7 21:35:33 UTC 2021

2021-02-07 21:35:33 +00:00 · 2021-02-07 21:35:33 +00:00 · 68444f5487
parent 3c1526fcd4
commit 68444f5487
5 changed files with 62 additions and 52 deletions
--- a/layers/+emacs/org/README.org
+++ b/layers/+emacs/org/README.org
@ -171,6 +171,7 @@ template. The value of the =org-contacts-files= variable should be a list with
 filenames to use as contact sources. If set to =nil= (default) then all your Org
 files will be used. The first file in the =org-contacts-files= list can be
 visited with the keyboard shortcut ~SPC a o C f~.
+
 #+BEGIN_SRC emacs-lisp
  (org :variables org-enable-org-contacts-support t
       org-contacts-files '("~/Org/contacts.org" "~/Org/file2.org")
@ -180,16 +181,19 @@ visited with the keyboard shortcut ~SPC a o C f~.
  :EMAIL: %(org-contacts-template-email)
  :END:")))
 #+END_SRC
+
 A more elaborate capture template can be found in the =org-contacts.el= file.

 Contacts can include the :BIRTHDAY: keyword. To include the birthdays in your
 org-agenda add ~%%(org-contacts-anniversaries)~ to one of your contacts files.
 It is important that this is inserted after a heading an that it has no
 preceding whitespace. So probably the best way is to add
+
 #+BEGIN_SRC emacs-lisp
  * Birthdays
  %%(org-contacts-anniversaries)
 #+END_SRC
+
 to the beginning or the end of one of your contacts files.

 *** V-Card import/export
--- a/layers/+lang/c-c++/README.org
+++ b/layers/+lang/c-c++/README.org
@ -209,7 +209,6 @@ have been disabled in favour of server,
 as recommended by =ccls= wikis.

 **** Debugger (dap integration)
-
 ***** Adapter selection
 To select the active adapters, configure the =c-c++-dap-adapters= layer variable.
 By default only the Microsoft extension is available.
@ -221,6 +220,7 @@ By default only the Microsoft extension is available.
 | LLVM Project | lldb                              | =dap-lldb=     |

 Example configuration with two adapters selected:
+
 #+BEGIN_SRC emacs-lisp
  (setq-default dotspacemacs-configuration-layers
                '((c-c++ :variables
--- a/layers/+lang/markdown/README.org
+++ b/layers/+lang/markdown/README.org
@ -56,9 +56,9 @@ A live preview can be generated when one of these executables are in path:
 - =pandoc=
 - =markdown_py=

-A well-knowned =markdown= command is from https://daringfireball.net/projects/markdown/.
+A well-knowned =markdown= command is from [[https://daringfireball.net/projects/markdown/]].
 Or follow =pandoc= installation instructions to install pandoc into path:
-https://pandoc.org/installing.html
+[[https://pandoc.org/installing.html]]

 Another choice is installing =Python-Markdown=:

--- a/layers/+tools/eaf/README.org
+++ b/layers/+tools/eaf/README.org
@ -2,12 +2,12 @@

 #+TAGS: layer|web service

-* Table of Contents                                       :TOC_4_gh:noexport:
+* Table of Contents                     :TOC_5_gh:noexport:
 - [[#description][Description]]
  - [[#features][Features:]]
 - [[#install][Install]]
 - [[#usage][Usage]]
-  - [[#configuring-keybindings][Configuring keybindings]]
+  - [[#configuring-key-bindings][Configuring key bindings]]
 - [[#key-bindings][Key bindings]]
  - [[#global][Global]]
    - [[#all-eaf-applications][All EAF-applications]]
@ -19,54 +19,54 @@
    - [[#pdf-view-mode-pdf-tools][pdf-view-mode (pdf-tools)]]

 * Description
-  This layer adds support for the [[https://github.com/manateelazycat/emacs-application-framework][Emacs Application Framework (EAF)]].
+This layer adds support for the [[https://github.com/manateelazycat/emacs-application-framework][Emacs Application Framework (EAF)]].

 ** Features:
-  - Browse using a full-fledged browser within Emacs
-  - PDF viewer (with continuous scroll)
-  - Video player
-  - Image viewer
-  - See [[https://github.com/manateelazycat/emacs-application-framework#launch-eaf-applications][EAF documentation]] for many more features
+- Browse using a full-fledged browser within Emacs
+- PDF viewer (with continuous scroll)
+- Video player
+- Image viewer
+- See [[https://github.com/manateelazycat/emacs-application-framework#launch-eaf-applications][EAF documentation]] for many more features

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

-  Subsequently install the required dependencies with =SPC SPC
+Subsequently install the required dependencies with =SPC SPC
  eaf-install-dependencies=. This command only works for Ubuntu and Fedora based
-  distributions. Users of Arch (based) distributions can run the script manually
-  in their terminal. If the script does not work for you then [[https://github.com/manateelazycat/emacs-application-framework#dependency-list][install the
-  required dependencies manually]].
+distributions. Users of Arch (based) distributions can run the script manually
+in their terminal. If the script does not work for you then [[https://github.com/manateelazycat/emacs-application-framework#dependency-list][install the
+required dependencies manually]].

 * Usage
+** Configuring key bindings
+Configuration of EAF key bindings works in a different way than normally in Spacemacs.

-** Configuring keybindings
-   Configuration of EAF keybindings works in a different way than normally in Spacemacs.
-   
-   Also EAF, and additionally this layer, implement some tricks that are
-   required to make leader keys in EAF buffers behave as expected in Spacemacs.
-   Therefore it is recommended to keep these default (major-mode-)leader
-   keybindings.
-   
-   For information about configuration of other key bindings for EAF, see [[https://github.com/manateelazycat/emacs-application-framework/wiki/Keybindings][here]]. 
+Also EAF, and additionally this layer, implement some tricks that are
+required to make leader keys in EAF buffers behave as expected in Spacemacs.
+Therefore it is recommended to keep these default (major-mode-)leader
+keybindings.

-   If you do want to modify the leader keys, then information about the tricks
-   implemented in this layer can be found [[https://github.com/manateelazycat/emacs-application-framework/issues/498][here]] and [[https://github.com/manateelazycat/emacs-application-framework/pull/500][here]].
+For information about configuration of other key bindings for EAF, see [[https://github.com/manateelazycat/emacs-application-framework/wiki/Keybindings][here]]. 
+
+If you do want to modify the leader keys, then information about the tricks
+implemented in this layer can be found [[https://github.com/manateelazycat/emacs-application-framework/issues/498][here]] and [[https://github.com/manateelazycat/emacs-application-framework/pull/500][here]].

 * Key bindings
-
 ** Global
 *** All EAF-applications
-| Key Binding | Description                                                           |
+
+| Key binding | Description                                                           |
 |-------------+-----------------------------------------------------------------------|
-| ~SPC a a f~ | EAF open file ([[https://github.com/manateelazycat/emacs-application-framework#launch-eaf-applications][see EAF doc for supported file types]])                   |
+| ~SPC a a f~ | EAF open file ([[https://github.com/manateelazycat/emacs-application-framework#launch-eaf-applications][see EAF doc for supported file types]])                  |
 | ~SPC t k m~ | Show available key commands in which-key (read [[https://develop.spacemacs.org/doc/DOCUMENTATION.html#which-key][here]] for more details) |
-| ~SPC m d~   | toggle dark-mode (in pdf-viewer just press ~d~)                      |
+| ~SPC m d~   | toggle dark-mode (in pdf-viewer just press ~d~)                       |

 *** Browser
-| Key Binding   | Description                                                           |
-|---------------+-----------------------------------------------------------------------|
+
+| Key binding   | Description                                                                           |
+|---------------+---------------------------------------------------------------------------------------|
 | ~SPC a a b o~ | Open url in new buffer                                                                |
 | ~SPC a a b s~ | Search with [[https://github.com/manateelazycat/emacs-application-framework/wiki/Customization#default-search-engine][your favorite search engine]]. Defaults to symbol at point or region string |
 | ~SPC a a b b~ | Open bookmark in new buffer                                                           |
@ -74,12 +74,14 @@

 ** Local
 *** All EAF-applications
-| Key Binding | Description    |
+
+| Key binding | Description    |
 |-------------+----------------|
 | ~j/k~       | Scroll up/down |

 *** Browser
-| Key Binding | Description                                                    |
+
+| Key binding | Description                                                    |
 |-------------+----------------------------------------------------------------|
 | ~J/K~       | Scroll (half) page up/down                                     |
 | ~e~         | Edit url                                                       |
@ -90,14 +92,16 @@
 | ~SPC m s~   | Search web with [[https://github.com/manateelazycat/emacs-application-framework/wiki/Customization#default-search-engine][favorite search engine]]                         |

 *** PDF-viewer
-| Key Binding | Description      |
+
+| Key binding | Description      |
 |-------------+------------------|
 | ~d~         | toggle dark-mode |

 *** pdf-view-mode (pdf-tools)
-| Key Binding | Description            |
+
+| Key binding | Description            |
 |-------------+------------------------|
 | ~SPC m e~   | open in eaf pdf-viewer |
-    
-There are many more keybindings. Use ~SPC t k m~ to [[https://develop.spacemacs.org/doc/DOCUMENTATION.html#which-key-persistent][show them persistently in
+
+There are many more key bindings. Use ~SPC t k m~ to [[https://develop.spacemacs.org/doc/DOCUMENTATION.html#which-key-persistent][show them persistently in
 which-key]], or use ~SPC h d k~ to show the `eaf-mode-map` in a separate buffer.
--- a/layers/LAYERS.org
+++ b/layers/LAYERS.org
@ -214,7 +214,6 @@
  - [[#dap][DAP]]
  - [[#debug][Debug]]
  - [[#docker][Docker]]
-  - [[#eaf-emacs-application-layer][EAF (Emacs Application Layer)]]
  - [[#fasd][Fasd]]
  - [[#finance][Finance]]
  - [[#geolocation][Geolocation]]
@ -252,6 +251,7 @@
  - [[#vinegar][Vinegar]]
 - [[#web-services][Web services]]
  - [[#confluence][Confluence]]
+  - [[#eaf][Eaf]]
  - [[#evernote][Evernote]]
  - [[#search-engine][Search Engine]]
  - [[#twitter][Twitter]]
@ -2774,16 +2774,6 @@ Features:
 - Syntax checking via [[https://github.com/hadolint/hadolint][hadolint]]
 - Code-Completion via =lsp=

-** EAF (Emacs Application Layer)
-[[file:+tools/eaf/README.org][+tools/eaf/README.org]]
-
-This layer integrates the [[https://github.com/clvv/fasd][fasd]] command line tool into Spacemacs.
-
-Features:
- Adds easy shortcuts to reference recent files and directories.
- Provides =fasd= with recent open file lists from Emacs.
- Allows to filter =fasd= results with =helm= or =ivy=.
-  
 ** Fasd
 [[file:+tools/fasd/README.org][+tools/fasd/README.org]]

@ -3197,6 +3187,18 @@ Features:
 - Creating/editing of Confluence pages
 - Exporting of org buffers to Confluence =wiki= format

+** Eaf
+[[file:+tools/eaf/README.org][+tools/eaf/README.org]]
+
+This layer adds support for the [[https://github.com/manateelazycat/emacs-application-framework][Emacs Application Framework (EAF)]].
+
+Features:
+- Browse using a full-fledged browser within Emacs
+- PDF viewer (with continuous scroll)
+- Video player
+- Image viewer
+- See [[https://github.com/manateelazycat/emacs-application-framework#launch-eaf-applications][EAF documentation]] for many more features
+
 ** Evernote
 [[file:+web-services/evernote/README.org][+web-services/evernote/README.org]]