Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation for internal spacemacs layers #10361

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 46 additions & 2 deletions layers/+distributions/spacemacs-base/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -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
22 changes: 20 additions & 2 deletions layers/+distributions/spacemacs/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -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
11 changes: 9 additions & 2 deletions layers/+spacemacs/spacemacs-evil/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -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
20 changes: 18 additions & 2 deletions layers/+spacemacs/spacemacs-language/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
8 changes: 6 additions & 2 deletions layers/+spacemacs/spacemacs-layouts/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -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
29 changes: 27 additions & 2 deletions layers/+spacemacs/spacemacs-modeline/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -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 |