TakeV
/
spacemacs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

documentation formatting: Fri Nov 8 16:03:53 UTC 2019

This commit is contained in:
emacspace 2019-11-08 16:03:53 +00:00 committed by Eugene Yaremenko
parent 6be744b8bb
commit c91779aff4
15 changed files with 91 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
layers/+emacs/org/README.org
View File

@ -130,7 +130,7 @@ the =gnuplot= package to your =dotspacemacs-excluded-packages= variable.
** Reveal.js support
To enable the export of org files as a [[http://lab.hakim.se/reveal-js/][reveal.js]] presentation - set the
variable =org-enable-reveal-js-support= to =t=.
This would install the [[https://gitlab.com/oer/org-re-reveal/][org-re-reveal] Emacs extension.
This would install the [[ [[https://gitlab.com/oer/org-re-reveal/]] ][org-re-reveal] Emacs extension.
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers

2
layers/+filetree/treemacs/README.org
View File

@ -71,7 +71,7 @@ part of the file system shown by treemacs set the layer variable
Default is =t=.
** Git mode
To enable Treemacs to check for files’ and directories’ git status information
To enable Treemacs to check for files' and directories' git status information
and highlight them accordingly, set the layer variable =treemacs-use-git-mode=
to =simple=, =extended=, or =deferred=. See the [[https://github.com/Alexander-Miller/treemacs#git-mode][Treemacs doc]] for a more detailed
explanation.

8
layers/+intl/japanese/README.org
View File

@ -58,10 +58,10 @@ For example, if you install [[https://www.kaoriya.net/software/cmigemo/][C/Migem
inside =dotspacemacs/user-config=, or
#+begin_src emacs-lisp
#+BEGIN_SRC emacs-lisp
(japanese :variables
migemo-dictionary "c:/app/cmigemo-default-win64/dict/utf-8/migemo-dict")
#+end_src
#+END_SRC
inside =dotspacemacs-configuration-layers=.
@ -75,10 +75,10 @@ If you want to use helm with migemo, you should add:
inside =dotspacemacs/user-config=, or
#+begin_src emacs-lisp
#+BEGIN_SRC emacs-lisp
(japanese :variables
helm-migemo-mode 1)
#+end_src
#+END_SRC
inside =dotspacemacs-configuration-layers=. Note that you may find in a package called
=helm-migemo.el= in MELPA. However, this package is deprecated and not supported

1
layers/+lang/conda/README.org
View File

@ -25,6 +25,7 @@ To use this layer you need to tell spacemacs where your anaconda
environment can be found. By default Spacemacs will check in =~/.anaconda3=.
If it is installed somewhere else just set =conda-anaconda-home= in your dotfile:
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers
'((conda :variables conda-anaconda-home "/your/path/here")))

2
layers/+lang/haskell/README.org
View File

@ -111,7 +111,7 @@ To choose a default backend set the layer variable =haskell-completion-backend=:
(haskell :variables haskell-completion-backend 'ghci)
#+END_SRC
Note that in order to enable completion, you'll have to enable the
Note that in order to enable completion, you'll have to enable the
=auto-completion= layer as well.
Alternatively the =lsp= backend will be automatically chosen if the layer =lsp=

1
layers/+lang/java/README.org
View File

@ -55,7 +55,6 @@ To choose a default backend set the layer variable =java-backend=:
(java :variables java-backend 'meghanada)
#+END_SRC
Alternatively the =lsp= backend will be automatically chosen if the layer =lsp=
is used and you did not specify any value for =java-backend=.

5
layers/+lang/javascript/README.org
View File

@ -152,10 +152,9 @@ You can choose formatting tool:
Default is =’web-beautify=.
** Format buffer before saving
#+begin_src elisp
#+BEGIN_SRC elisp
(javascript :variables javascript-fmt-on-save t)
#+end_src
#+END_SRC
* Backends
** Tern

1
layers/+lang/julia/README.org
View File

@ -32,7 +32,6 @@ file.
This layer can be used with [[https://github.com/JuliaEditorSupport/LanguageServer.jl][LanguageServer.jl]] and Emacs [[https://github.com/emacs-lsp/lsp-mode][lsp-mode]] to provide
richer, IDE-like capabilities. To use this layer with lsp, you must do the
following:
1. =LanguageServer.jl= should be configured automatically, if not, see the
documentation of =lsp-julia=.
2. define the layer variable =julia-backend= to =lsp= in your dotfile

12
layers/+lang/mercury-layer/README.org
View File

@ -1,8 +1,10 @@
#+TITLE: mercury layer
#+TAGS: layer|uncategorized
[[file:img/mercury.png]]
* Table of Contents :TOC_4_gh:noexport:
* Table of Contents :TOC_5_gh:noexport:
- [[#description][Description]]
- [[#features][Features:]]
- [[#install][Install]]
@ -12,9 +14,9 @@
This layer adds support for the Mercury language.
** Features:
- Indentation.
- Syntax highlighting.
- Compiling and running.
- Indentation.
- Syntax highlighting.
- Compiling and running.
* Install
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
@ -23,7 +25,7 @@ file.
* Key bindings
| Key Binding | Description |
| Key binding | Description |
|-------------+--------------------------------------|
| ~SPC m c b~ | Compile current buffer file. |
| ~SPC m c r~ | Compile and run current buffer file. |

1
layers/+lang/python/README.org
View File

@ -79,7 +79,6 @@ To choose a default backend set the layer variable =python-backend=:
(python :variables python-backend 'anaconda)
#+END_SRC
Alternatively the =lsp= backend will be automatically chosen if the layer =lsp=
is used and you did not specify any value for =python-backend=.

6
layers/+lang/racket/README.org
View File

@ -99,7 +99,7 @@ When enabled the symbol =🆂= should be displayed in the mode-line.
** Other key bindings
| Key binding | Description |
|-------------+---------------------------------------------------------------------------------|
| ~SPC m i l~ | Insert lambda character |
| Key binding | Description |
|-------------+-----------------------------------------------------------------------------------|
| ~SPC m i l~ | Insert lambda character |
| ~H-r~ | Run current file and open REPL (=H= is hyper, *may* be bound to command on macOS) |

3
layers/+lang/scala/README.org
View File

@ -104,7 +104,7 @@ Follow [[https://ensime.github.io/build_tools/sbt/][the ENSIME configuration ins
the development version of Ensime so follow the appropriate steps.
To use the build functions under ~SPC m b~ you need to use version =0.13.5= or
newer of =sbt=, and specify that in your project’s =project/build.properties=.
newer of =sbt=, and specify that in your project's =project/build.properties=.
For example,
#+BEGIN_SRC scala
@ -212,7 +212,6 @@ with
#+END_SRC
* Key bindings
** Ensime
*** Search

24
layers/+tools/dap/README.org
View File

@ -52,10 +52,10 @@ register itself using the variable =spacemacs--dap-supported-modes=.
For instance the =java= layer:
#+begin_src emacs-lisp
(defun java/pre-init-dap-mode ()
(add-to-list 'spacemacs--dap-supported-modes 'java-mode))
#+end_src
#+BEGIN_SRC emacs-lisp
(defun java/pre-init-dap-mode ()
(add-to-list 'spacemacs--dap-supported-modes 'java-mode))
#+END_SRC
See the =java= layer for further example on how to setup correctly =dap-mode=.
@ -90,14 +90,14 @@ transient state which can be initiate with ~SPC m d .~.
** Start/Stop
| Key binding | Description |
|---------------+---------------------------------|
| ~SPC m d A~ | abandon all process |
| ~SPC m d a~ | abandon current session |
| ~SPC m d d d~ | start debugging |
| ~SPC m d d e~ | edit debug template |
| ~SPC m d d l~ | debug last configuration |
| ~SPC m d d r~ | debug recent configuration |
| Key binding | Description |
|---------------+----------------------------|
| ~SPC m d A~ | abandon all process |
| ~SPC m d a~ | abandon current session |
| ~SPC m d d d~ | start debugging |
| ~SPC m d d e~ | edit debug template |
| ~SPC m d d l~ | debug last configuration |
| ~SPC m d d r~ | debug recent configuration |
** Breakpoints

19
layers/+tools/shell/README.org
View File

@ -12,17 +12,17 @@
- [[#check-that-your-emacs-supports-dynamic-modules][Check that your Emacs supports dynamic modules]]
- [[#install-cmake-311-or-higher][Install CMake 3.11 or higher]]
- [[#macos][macOS]]
- [[#ubuntu-2][Ubuntu]]
- [[#install-libtool][Install libtool]]
- [[#ubuntu][Ubuntu]]
- [[#install-libtool][Install libtool]]
- [[#ubuntu-1][Ubuntu]]
- [[#install-libvterm][Install libvterm]]
- [[#macos-1][macOS]]
- [[#ubuntu-1][Ubuntu]]
- [[#ubuntu-2][Ubuntu]]
- [[#windows][Windows]]
- [[#configuration][Configuration]]
- [[#default-shell][Default shell]]
- [[#default-shell-position-width-and-height][Default shell position, width, and height]]
- [[#set-shell-for-term-and-ansi-term][Set shell for term and ansi-term]]
- [[#set-shell-for-term-ansi-term-and-vterm][Set shell for term, ansi-term and vterm]]
- [[#set-shell-for-multi-term][Set shell for multi-term]]
- [[#width-of-the-shell-popup-buffers][Width of the shell popup buffers]]
- [[#enable-em-smart-in-eshell][Enable em-smart in Eshell]]
@ -63,12 +63,12 @@ source supplying the =./configure --with-module= option at configure time.
*** Install CMake 3.11 or higher
**** macOS
#+BEGIN_SRC shell
brew install cmake
brew install cmake
#+END_SRC
**** Ubuntu
#+BEGIN_SRC shell
sudo apt install cmake
sudo apt install cmake
#+END_SRC
*** Install libtool
@ -77,18 +77,18 @@ If the =libtool= command does not exist in your system (usually in
**** Ubuntu
#+BEGIN_SRC shell
sudo apt install libtool-bin
sudo apt install libtool-bin
#+END_SRC
*** Install libvterm
**** macOS
#+BEGIN_SRC shell
brew install libvterm
brew install libvterm
#+END_SRC
**** Ubuntu
#+BEGIN_SRC shell
sudo apt install libvterm-dev
sudo apt install libvterm-dev
#+END_SRC
In other distros, find it and install it in your favorite package manager.
@ -97,7 +97,6 @@ In other distros, find it and install it in your favorite package manager.
Not supported at the moment, [[https://github.com/akermu/emacs-libvterm/issues/12][but possibly coming up]].
* Configuration
** Default shell
Emacs supports five types of shells/terminals:
- the Emacs shell (eshell)

71
layers/LAYERS.org
View File

@ -158,6 +158,7 @@
- [[#haskell][Haskell]]
- [[#idris][Idris]]
- [[#utilities][Utilities]]
- [[#conda-layer][Conda layer]]
- [[#dotnet][Dotnet]]
- [[#ipython-notebook][Ipython notebook]]
- [[#protocol-buffers][Protocol buffers]]
@ -170,6 +171,7 @@
- [[#pdf][Pdf]]
- [[#speed-reading][Speed reading]]
- [[#readmeorg-files-that-need-proper-tags][README.org files that need proper tags]]
- [[#mercury][Mercury]]
- [[#zig][Zig]]
- [[#source-control][Source control]]
- [[#git][Git]]
@ -330,6 +332,7 @@ Features:
- Frequency-based suggestions via [[https://github.com/company-mode/company-statistics][company-statistics]] for =company=
- Integration with [[https://github.com/capitaomorte/yasnippet][yasnippet]] and [[https://github.com/abo-abo/auto-yasnippet][auto-yasnippet]]
- Automatic configuration of [[https://www.emacswiki.org/emacs/HippieExpand][hippie-expand]]
- Automatic docstring tooltips are provided by [[https://github.com/expez/company-quickhelp][company-quickhelp]]
** Helm
[[file:+completion/helm/README.org][+completion/helm/README.org]]
@ -540,7 +543,7 @@ readme]]. In a short summary Treemacs offers the following:
- Optionally fontifying files based on their git status.
- Optionally collapsing single-dir-child directories into one.
- Doing both asynchronously for an imperceptible performance cost.
- Optional =follow-mode= to automatically focus the currently selected file.
- Optional =follow-mode= to automatically focus the currently selected file or tag.
- Optional =filewatch-mode= to automatically refresh the view after (and only
after) changes to the shown filesystem.
@ -554,7 +557,7 @@ install the fonts listed in the [[https://github.com/rolandwalker/unicode-fonts#
Features:
- Display unicode glyphs using the best available font.
- Easily override glyphs or sections of glyphs.
- Display color emoji on both the Mac port version of Emacs and emacs-plus (with
- Display color emoji on both the macOS port version of Emacs and emacs-plus (with
=unicode-fonts-force-multi-color-on-mac= set to non nil).
* Fun
@ -975,8 +978,8 @@ Features:
** Osx
[[file:+os/osx/README.org][+os/osx/README.org]]
Spacemacs is not just emacs+vim. It can have OSX key bindings too! This layer
globally defines common OSX key bindings.
Spacemacs is not just Emacs plus Vim. It can have macOS key bindings too! This
layer globally defines common macOS key bindings.
Features:
- ~⌘~ is set to ~hyper~ and ~⌥~ is set to ~meta~
@ -1149,7 +1152,7 @@ Features:
- REPL via [[https://github.com/clojure-emacs/cider][CIDER]]
- Code formatting via [[https://github.com/clojure-emacs/cider][CIDER]] using [[https://github.com/weavejester/cljfmt][Cljfmt]]
- Refactoring via [[https://github.com/clojure-emacs/clj-refactor.el][clj-refactor]]
- Linting via [[https://github.com/clojure-emacs/squiggly-clojure][squiggly-clojure]]
- Linting via [[https://github.com/clojure-emacs/squiggly-clojure][squiggly-clojure]], [[https://github.com/borkdude/clj-kondo][clj-kondo]] or [[https://github.com/candid82/joker][joker]]
- Aligning of code forms via [[https://github.com/clojure-emacs/clojure-mode][clojure-mode]]
- Debugging with [[https://github.com/clojure-emacs/sayid][sayid]]
- Clojure cheatsheet
@ -1434,6 +1437,7 @@ Features:
- Auto-completion using [[https://github.com/Alexander-Miller/company-shell][company-shell]]
- =Sh= scripts linting using [[https://www.shellcheck.net/][shellcheck]]
- =Sh= scripts style checking using [[https://github.com/openstack-dev/bashate][bashate]]
- Support for the [[https://langserver.org/][Language Server Protocol]] (experimental)
**** Vimscript language
[[file:+lang/vimscript/README.org][+lang/vimscript/README.org]]
@ -1660,6 +1664,7 @@ Features:
- Flycheck support for mix compile
- Flycheck support for [[https://github.com/rrrene/credo][credo]]
- Flycheck support for test results
- Interactive debugger using [[https://github.com/emacs-lsp/dap-mode][dap-mode]]
**** Erlang
[[file:+lang/erlang/README.org][+lang/erlang/README.org]]
@ -1743,14 +1748,12 @@ This layer adds support for the Java language.
Features:
- Support for the following backends:
- [[https://github.com/mopemope/meghanada-emacs][Meghanada]] client/server (default),
- [[http://eclim.org][Eclim]] client/server,
- [[https://ensime.github.io/][ENSIME]] client/server.
- [[https://github.com/emacs-lsp/lsp-java][LSP Java]] client/server.
- Each provides:
- Auto-completion using company
- Linting using flycheck integration
- Maven and Gradle integration
- [[https://github.com/emacs-lsp/lsp-java][LSP Java]] client/server (default)
- [[https://github.com/mopemope/meghanada-emacs][Meghanada]] client/server
- Auto-completion using company
- Linting using flycheck integration
- Maven and Gradle integration
- Interactive debugger using [[https://github.com/emacs-lsp/dap-mode][dap-mode]]
**** Jr concurrent programming language
[[file:+lang/jr/README.org][+lang/jr/README.org]]
@ -1866,6 +1869,7 @@ Features:
- Complete and jump to define with [[https://github.com/xcwen/ac-php][company-php]]
- Run tests with PHPUnit
- Reformat code with PHP CBF
- Support for the [[https://langserver.org/][Language Server Protocol]] (experimental)
The =gtags= layer is recommended to benefit from better =eldoc= and
=helm-gtags=.
@ -1894,6 +1898,7 @@ Features:
- Sort imports with [[https://pypi.python.org/pypi/isort][isort]]
- Fix a missing import statement with [[https://github.com/anachronic/importmagic.el][importmagic]]
- Pip package manager with [[https://github.com/brotzeit/pippel][pippel]]
- Interactive debugger using [[https://github.com/emacs-lsp/dap-mode][dap-mode]]
**** Racket
[[file:+lang/racket/README.org][+lang/racket/README.org]]
@ -1931,6 +1936,7 @@ Features:
- Rake runner
- Linter (rubocop)
- Interactive REPL and code navigation (robe)
- Interactive debugger using [[https://github.com/emacs-lsp/dap-mode][dap-mode]]
**** Rust
[[file:+lang/rust/README.org][+lang/rust/README.org]]
@ -1939,6 +1945,7 @@ This layer supports [[https://www.rust-lang.org][Rust]] development in Spacemacs
Features:
- Auto-completion and navigation support through [[https://github.com/emacs-lsp/lsp-rust][lsp]] or [[https://github.com/phildawes/racer][Racer]]
- Interactive debugger using [[https://github.com/emacs-lsp/dap-mode][dap-mode]]
- support for the Rust package manager [[http://doc.crates.io/index.html][Cargo]]
**** Scala
@ -2007,7 +2014,8 @@ Features:
- Auto-completion and documentation
- Browser based REPL available via [[https://github.com/skeeto/skewer-mode][skewer-mode]] and [[https://github.com/pandeiro/livid-mode][livid-mode]]
- Server based REPL with [[https://github.com/abicky/nodejs-repl.el][nodejs-repl]]
- Formatting with [[https://github.com/yasuyk/web-beautify][web-beautify]]
- Formatting with [[https://github.com/yasuyk/web-beautify][web-beautify]] or [[https://github.com/prettier/prettier][prettier]]
- Interactive debugger using [[https://github.com/emacs-lsp/dap-mode][dap-mode]]
***** Purescript
[[file:+lang/purescript/README.org][+lang/purescript/README.org]]
@ -2093,6 +2101,15 @@ Features:
- Integration of the =Idris= build system
** Utilities
*** Conda layer
[[file:+lang/conda/README.org][+lang/conda/README.org]]
This layer adds support for the Anaconda python environment for
numerical computations to Spacemacs.
Features:
- Controlling =Anaconda= or =Miniconda= environments directly from emacs with [[https://github.com/necaris/conda.el][conda.el]]
*** Dotnet
[[file:+tools/dotnet/README.org][+tools/dotnet/README.org]]
@ -2136,13 +2153,13 @@ Features:
** Dash
[[file:+readers/dash/README.org][+readers/dash/README.org]]
This layer integrates offline api browsers into Emacs. It provides one for OS X, Linux and Windows.
This layer integrates offline API browsers into Emacs. It provides one for macOS, Linux and Windows.
Features:
- Searching for word at point in offline api browser's UI.
- Integration of offline api browser search results in helm and ivy.
- Support for [[https://kapeli.com/dash][dash]] offline api browser for OS X.
- Support for [[https://zealdocs.org/][zeal]] offline api browser for Linux.
- Searching for word at point in offline API browser's UI.
- Integration of offline API browser search results in Helm and Ivy.
- Support for [[https://kapeli.com/dash][dash]] offline API browser for macOS.
- Support for [[https://zealdocs.org/][zeal]] offline API browser for Linux.
** Deft
[[file:+readers/deft/README.org][+readers/deft/README.org]]
@ -2209,6 +2226,16 @@ Features:
- Support for =speed-reading= of arbitrary texts
* README.org files that need proper tags
** Mercury
[[file:+lang/mercury-layer/README.org][+lang/mercury-layer/README.org]]
This layer adds support for the Mercury language.
Features:
- Indentation.
- Syntax highlighting.
- Compiling and running.
** Zig
[[file:+lang/zig/README.org][+lang/zig/README.org]]
@ -2324,7 +2351,7 @@ with GUI support on all major platforms and even [[https://i.imgur.com/wDLDMZN.g
Features:
- Automatically get Spacemacs layers dependency installed with [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Bdistributions/spacemacs-docker/deps-install/README.org][installer scripts]]
- Reap the benefit of Emacs and other GNU/Linux tools on Windows/MacOS machines
- Reap the benefit of Emacs and other GNU/Linux tools on Windows or macOS machines
- Use [[https://hub.docker.com/][docker hub]] to auto-build your environment and store full backups for free
- Build once and work with the same development environment everywhere
- Run untrusted/risky code in the tunable sandbox with CPU/network/disk quotas
@ -2571,7 +2598,7 @@ Features:
- Supports the following adjustments:
- Automatic switching between light (day) and dark (night) themes via [[https://github.com/hadronzoo/theme-changer][theme-changer]]
- Local weather forecast via [[https://github.com/aaronbieber/sunshine.el/blob/master/sunshine.el][sunshine]]
- Integration with OS X's CoreLocation service via [[https://github.com/purcell/osx-location][osx-location]]
- Integration with macOS's CoreLocation service via [[https://github.com/purcell/osx-location][osx-location]]
- Manual location setting via variables in your dotfile
** Imenu-list
@ -2836,7 +2863,7 @@ Features:
Features:
- adds copy support to the X-clipboard from the terminal.
- adds paste support to the X-clipboard from the terminal.
- [[https://github.com/redguardtoo/cliphist][cliphist]] package: integration with clipboard managers on Linux and Mac.
- [[https://github.com/redguardtoo/cliphist][cliphist]] package: integration with clipboard managers on Linux and macOS.
** Ycmd
[[file:+tools/ycmd/README.org][+tools/ycmd/README.org]]