From 04e2f0978c4aeb56173764e7c05510dd552a477c Mon Sep 17 00:00:00 2001 From: smile13241324 Date: Sat, 17 Feb 2018 23:58:59 +0100 Subject: [PATCH] Fix doc for first bunch of internal spacemacs layers --- .../+distributions/spacemacs-base/README.org | 48 ++++++++++++++++++- layers/+distributions/spacemacs/README.org | 22 ++++++++- layers/+spacemacs/spacemacs-evil/README.org | 11 ++++- .../+spacemacs/spacemacs-language/README.org | 20 +++++++- .../+spacemacs/spacemacs-layouts/README.org | 8 +++- .../+spacemacs/spacemacs-modeline/README.org | 29 ++++++++++- 6 files changed, 126 insertions(+), 12 deletions(-) diff --git a/layers/+distributions/spacemacs-base/README.org b/layers/+distributions/spacemacs-base/README.org index 231e565366b5..263f0167e79d 100644 --- a/layers/+distributions/spacemacs-base/README.org +++ b/layers/+distributions/spacemacs-base/README.org @@ -2,7 +2,51 @@ * Table of Contents :TOC_4_gh:noexport: - [[#description][Description]] - - [[#describe-spacemacs-base-distribution-in-this-file][describe spacemacs-base distribution in this file]] + - [[#features][Features:]] * Description -** TODO describe spacemacs-base distribution in this file +This is the base distribution for Spacemacs. + +** Features: +- Minimalistic approach to Spacemacs, contains only the core packages. Good starting + point to make something completely new. This distribution should not be used for + a new standalone Spacemacs installation except you have very good reasons to. + It contains the following packages: + - abbrev + - ace-window + - archive-mode + - bookmark + - centered-buffer-mode + - conf-mode + - dired + - electric-indent-mode + - ediff + - eldoc + - evil-escape + - evil-evilified-state + - evil-visualstar + - help-fns+ + - hi-lock + - holy-mode + - hybrid-mode + - image-mode + - imenu + - linum + - occur-mode + - package-menu + - page-break-lines + - pcre2el + - process-menu + - projectile + - recentf + - savehist + - saveplace + - spacemacs-theme + - subword + - tar-mode + - uniquify + - url + - visual-line-mode + - whitespace + - winner + - zone diff --git a/layers/+distributions/spacemacs/README.org b/layers/+distributions/spacemacs/README.org index ddfd09daae56..faf9a2f9cc66 100644 --- a/layers/+distributions/spacemacs/README.org +++ b/layers/+distributions/spacemacs/README.org @@ -2,7 +2,25 @@ * Table of Contents :TOC_4_gh:noexport: - [[#description][Description]] - - [[#describe-spacemacs-distribution-in-this-file][describe spacemacs distribution in this file]] + - [[#features][Features:]] * Description -** TODO describe spacemacs distribution in this file +This is the default distribution for Spacemacs. + +** Features: +- Easy access to the Spacemacs experience by adding below auxiliary layers + to the base distribution. + - helm + - neotree + - spacemacs-completion + - spacemacs-layouts + - spacemacs-editing + - spacemacs-editing-visual + - spacemacs-evil + - spacemacs-language + - spacemacs-misc + - spacemacs-modeline + - spacemacs-navigation + - spacemacs-org + - spacemacs-purpose + - spacemacs-visual diff --git a/layers/+spacemacs/spacemacs-evil/README.org b/layers/+spacemacs/spacemacs-evil/README.org index f596b0a5065b..abc975fc0b3d 100644 --- a/layers/+spacemacs/spacemacs-evil/README.org +++ b/layers/+spacemacs/spacemacs-evil/README.org @@ -2,7 +2,14 @@ * Table of Contents :TOC_4_gh:noexport: - [[#description][Description]] - - [[#describe-spacemacs-evil-layer-in-this-file][describe spacemacs-evil layer in this file]] + - [[#features][Features:]] * Description -** TODO describe spacemacs-evil layer in this file +This layer adds various adjustments to packages to create an evilified experience +througout the entirety of Spacemacs. + +** Features: +- Support for additional vim movements via =evil-args= +- Support for surrounding the marked area with a given character via =evil-surround= +- Evilification of various modes if the editing style is =vim= or =hybrid= +- Improves the comment function to be able to also do the inverse operation diff --git a/layers/+spacemacs/spacemacs-language/README.org b/layers/+spacemacs/spacemacs-language/README.org index 29d5bdb97329..d12b5ed06258 100644 --- a/layers/+spacemacs/spacemacs-language/README.org +++ b/layers/+spacemacs/spacemacs-language/README.org @@ -2,7 +2,23 @@ * Table of Contents :TOC_4_gh:noexport: - [[#description][Description]] - - [[#describe-spacemacs-language-layer-in-this-file][describe spacemacs-language layer in this file]] + - [[#features][Features:]] +- [[#key-bindings][Key bindings]] * Description -** TODO describe spacemacs-language layer in this file +This layer adds support various language related services to Spacemacs. + +** Features: +- Show definition of word at point via [[https://github.com/abo-abo/define-word][define-word]]. +- Integration of google-translate into emacs via [[https://github.com/atykhonov/google-translate][google-translate]]. + +* Key bindings + + | Key Binding | Description | + |-------------+----------------------------------------------------------| + | ~SPC x w d~ | Show definition of word at point | + | ~SPC x g l~ | Set the source and target languages for google translate | + | ~SPC x g Q~ | Send marked area to google translate as reverse query | + | ~SPC x g q~ | Send marked area to google translate as forward query | + | ~SPC x g T~ | Send word at point to google translate as reverse query | + | ~SPC x g t~ | Send word at point to google translate as forward query | diff --git a/layers/+spacemacs/spacemacs-layouts/README.org b/layers/+spacemacs/spacemacs-layouts/README.org index 6d0b0b3b34fb..cd3b9149d48b 100644 --- a/layers/+spacemacs/spacemacs-layouts/README.org +++ b/layers/+spacemacs/spacemacs-layouts/README.org @@ -2,7 +2,11 @@ * Table of Contents :TOC_4_gh:noexport: - [[#description][Description]] - - [[#describe-spacemacs-layouts-layer-in-this-file][describe spacemacs-layouts layer in this file]] + - [[#features][Features:]] * Description -** TODO describe spacemacs-layouts layer in this file +This layer adds support for distinct layouts/workspaces to Spacemacs. + +** Features: +- Support for distinct layouts via =eyebrowse= +- Integration with =helm= and =ivy= to search for buffers within layouts diff --git a/layers/+spacemacs/spacemacs-modeline/README.org b/layers/+spacemacs/spacemacs-modeline/README.org index a645924c8a15..efdb7c17111e 100644 --- a/layers/+spacemacs/spacemacs-modeline/README.org +++ b/layers/+spacemacs/spacemacs-modeline/README.org @@ -2,7 +2,32 @@ * Table of Contents :TOC_4_gh:noexport: - [[#description][Description]] - - [[#describe-spacemacs-modeline-layer-in-this-file][describe spacemacs-modeline layer in this file]] + - [[#features][Features:]] +- [[#key-bindings][Key bindings]] * Description -** TODO describe spacemacs-modeline layer in this file +This layer adds various mode-lines to Spacemacs. + +** Features: +- Display of a vim-powerline like mode-line being able to show various information like + - Current battery status + - All active minor modes displayed as unicode symbols + - The active major mode + - The current branch if the file is in version control + - The current cursor position + - The system clock +- Display of a small system monitor in a separate mode-line. + +* Key bindings + + | Key Binding | Description | + |-------------+--------------------------------------------------------| + | ~SPC t m b~ | Display battery state in mode-line | + | ~SPC t m r~ | Make the mode-line responsive | + | ~SPC t m m~ | Display active minor modes in mode-line | + | ~SPC t m M~ | Display active major mode in mode-line | + | ~SPC t m v~ | Display version control information in mode-line | + | ~SPC t m V~ | Display new mode-line version | + | ~SPC t m p~ | Display cursor position in mode-line | + | ~SPC t m c~ | Display a clock in mode-line | + | ~SPC t m s~ | Display a small system monitor in a separate mode-line |