From cca6bc15a86c4cabd08ec39eea319bc842f9763d Mon Sep 17 00:00:00 2001 From: emacspace Date: Sat, 13 Oct 2018 23:09:18 +0000 Subject: [PATCH] documentation fixes:Sat Oct 13 23:09:18 UTC 2018 --- layers/+lang/ipython-notebook/README.org | 3 + layers/+lang/julia/README.org | 12 +-- layers/+lang/pact/README.org | 2 +- layers/+lang/typescript/README.org | 4 +- layers/+tools/shell/README.org | 1 - layers/LAYERS.org | 116 +++++++++++++++++------ 6 files changed, 99 insertions(+), 39 deletions(-) diff --git a/layers/+lang/ipython-notebook/README.org b/layers/+lang/ipython-notebook/README.org index eb7368143..ecb05a430 100644 --- a/layers/+lang/ipython-notebook/README.org +++ b/layers/+lang/ipython-notebook/README.org @@ -37,8 +37,11 @@ lots of informative stuff. This is a WIP, feel free to collaborate. ** TODO Maybe it'd be better if there was a state for this + ** TODO Make more keybinding to =connect= to a python buffer + ** TODO Deleting visual regions don't work, find out why + * Install ** Layer To use this configuration layer, add it to your =~/.spacemacs=. You will need to diff --git a/layers/+lang/julia/README.org b/layers/+lang/julia/README.org index 17977a1ec..c55876373 100644 --- a/layers/+lang/julia/README.org +++ b/layers/+lang/julia/README.org @@ -31,25 +31,25 @@ Warning: enabling the LSP functionality within this package can cause emacs to hang for significant lengths of time when opening a Julia file. See tip below on using PackageCompiler.jl to mitigate this issue. -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 +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. Add =lsp= to =dotspacemacs-configuration-layers=. 2. Install =LanguageServer.jl= by invoking =Pkg.add("LanguageServer")= in the - Julia REPL. + Julia REPL. 3. Enable layer integration with lsp as described in section below. =LanguageServer.jl= tends to have a very long startup time. In the worst case, =lsp-mode= might give up on the language server before its started, but regardless usage of =lsp-mode= with Julia can cause long delays when first opening files. To mitigate this issue, you can try compiling =LanguageServer.jl= -ahead of time using [[https://github.com/JuliaLang/PackageCompiler.jl][ =PackageCompiler.jl= ]]. This drastically reduces startup time +ahead of time using [[https://github.com/JuliaLang/PackageCompiler.jl][ =PackageCompiler.jl=]]. This drastically reduces startup time if successful: #+BEGIN_SRC julia -julia> Pkg.add("PackageCompiler") -julia> using PackageCompiler -julia> compile_package("LanguageServer") + julia> Pkg.add("PackageCompiler") + julia> using PackageCompiler + julia> compile_package("LanguageServer") #+END_SRC * Options diff --git a/layers/+lang/pact/README.org b/layers/+lang/pact/README.org index 650b22ddc..eb2ace7d8 100644 --- a/layers/+lang/pact/README.org +++ b/layers/+lang/pact/README.org @@ -1,6 +1,6 @@ #+TITLE: Pact layer -* Table of Contents :TOC_4_gh:noexport: +* Table of Contents :TOC_4_gh:noexport: - [[#description][Description]] - [[#features][Features:]] - [[#install][Install]] diff --git a/layers/+lang/typescript/README.org b/layers/+lang/typescript/README.org index 43dd50fa6..bd1a6be52 100644 --- a/layers/+lang/typescript/README.org +++ b/layers/+lang/typescript/README.org @@ -143,9 +143,9 @@ You have to install the following dependencies with npm. | ~SPC m g t~ | jump to entity’s type definition | | ~SPC m g u~ | references | | ~SPC m h h~ | documentation at point | -| ~SPC m r i~ | organize imports +| ~SPC m r i~ | organize imports | | ~SPC m r r~ | rename symbol | -| ~SPC m r f~ | rename file | +| ~SPC m r f~ | rename file | | ~SPC m s p~ | send selected region or current buffer to the web playground | | ~SPC m s r~ | restart server | diff --git a/layers/+tools/shell/README.org b/layers/+tools/shell/README.org index 8eac83f14..c2a888355 100644 --- a/layers/+tools/shell/README.org +++ b/layers/+tools/shell/README.org @@ -43,7 +43,6 @@ You can find a quick introductions to them [[https://www.masteringemacs.org/arti To define the default shell you can set the layer variable =shell-default-shell= to the following variables: - - =eshell= - =shell= - =term= diff --git a/layers/LAYERS.org b/layers/LAYERS.org index d14d33e9c..8bb9f612d 100644 --- a/layers/LAYERS.org +++ b/layers/LAYERS.org @@ -1,26 +1,31 @@ #+TITLE: Configuration layers +#+HTML_HEAD_EXTRA: -* Table of Contents :TOC_4_gh:noexport: -- [[#chat][Chat]] -- [[#checkers][Checkers]] -- [[#completion][Completion]] -- [[#distributions][Distributions]] -- [[#emacs][Emacs]] -- [[#e-mail][E-mail]] -- [[#frameworks][Frameworks]] -- [[#fun][Fun]] -- [[#international-support][International support]] -- [[#programming-and-markup-languages][Programming and markup languages]] -- [[#misc][Misc]] -- [[#operating-systems][Operating systems]] -- [[#pair-programming][Pair programming]] -- [[#source-control][Source control]] -- [[#spacemacs-distribution-layers][Spacemacs distribution layers]] -- [[#tags][Tags]] -- [[#themes][Themes]] -- [[#tools][Tools]] -- [[#vim][Vim]] -- [[#web-services][Web services]] +* Table of Contents :TOC_4_org:noexport: +- [[Chat][Chat]] +- [[Checkers][Checkers]] +- [[Completion][Completion]] +- [[Distributions][Distributions]] +- [[Emacs][Emacs]] +- [[E-mail][E-mail]] +- [[Filetree][Filetree]] +- [[Fonts][Fonts]] +- [[Frameworks][Frameworks]] +- [[Fun][Fun]] +- [[International support][International support]] +- [[Programming and markup languages][Programming and markup languages]] +- [[Misc][Misc]] +- [[Music][Music]] +- [[Operating systems][Operating systems]] +- [[Pair programming][Pair programming]] +- [[Readers][Readers]] +- [[Source control][Source control]] +- [[Spacemacs distribution layers][Spacemacs distribution layers]] +- [[Tags][Tags]] +- [[Themes][Themes]] +- [[Tools][Tools]] +- [[Vim][Vim]] +- [[Web services][Web services]] * Chat - [[file:+chat/erc/README.org][erc]] @@ -36,8 +41,12 @@ - [[file:+completion/auto-completion/README.org][auto-completion]] - [[file:+completion/helm/README.org][helm]] - [[file:+completion/ivy/README.org][ivy]] +- [[file:+completion/templates/README.org][templates]] * Distributions +- [[file:+distributions/spacemacs/README.org][spacemacs]] +- [[file:+distributions/spacemacs-base/README.org][spacemacs-base]] +- [[file:+distributions/spacemacs-bootstrap/README.org][spacemacs-bootstrap]] - [[file:+distributions/spacemacs-docker/README.org][spacemacs-docker]] * Emacs @@ -51,9 +60,19 @@ * E-mail - [[file:+email/gnus/README.org][gnus]] - [[file:+email/mu4e/README.org][mu4e]] +- [[file:+email/notmuch/README.org][notmuch]] + +* Filetree +- [[file:+filetree/neotree/README.org][neotree]] +- [[file:+filetree/treemacs/README.org][treemacs]] + +* Fonts +- [[file:+fonts/unicode-fonts/README.org][unicode-fonts]] * Frameworks - [[file:+frameworks/django/README.org][django]] +- [[file:+frameworks/emberjs/README.org][emberjs]] +- [[file:+frameworks/phoenix/README.org][phoenix]] - [[file:+frameworks/react/README.org][react]] - [[file:+frameworks/ruby-on-rails/README.org][ruby-on-rails]] @@ -65,6 +84,7 @@ * International support - [[file:+intl/chinese/README.org][chinese]] +- [[file:+intl/japanese/README.org][japanese]] - [[file:+intl/keyboard-layout/README.org][keyboard-layout]] * Programming and markup languages @@ -75,8 +95,10 @@ - [[file:+lang/bibtex/README.org][bibtex]] - [[file:+lang/c-c++/README.org][c-c++]] - [[file:+lang/clojure/README.org][clojure]] +- [[file:+lang/coffeescript/README.org][coffeescript]] - [[file:+lang/common-lisp/README.org][common-lisp]] - [[file:+lang/coq/README.org][coq]] +- [[file:+lang/crystal/README.org][crystal]] - [[file:+lang/csharp/README.org][csharp]] - [[file:+lang/csv/README.org][csv]] - [[file:+lang/d/README.org][d]] @@ -85,25 +107,34 @@ - [[file:+lang/emacs-lisp/README.org][emacs-lisp]] - [[file:+lang/erlang/README.org][erlang]] - [[file:+lang/ess/README.org][ess]] +- [[file:+lang/factor/README.org][factor]] - [[file:+lang/faust/README.org][faust]] - [[file:+lang/forth/README.org][forth]] - [[file:+lang/fsharp/README.org][fsharp]] - [[file:+lang/go/README.org][go]] - [[file:+lang/gpu/README.org][gpu]] - [[file:+lang/graphviz/README.org][graphviz]] +- [[file:+lang/groovy/README.org][groovy]] - [[file:+lang/haskell/README.org][haskell]] - [[file:+lang/html/README.org][html]] +- [[file:+lang/hy/README.org][hy]] - [[file:+lang/idris/README.org][idris]] - [[file:+lang/ipython-notebook/README.org][ipython-notebook]] - [[file:+lang/java/README.org][java]] - [[file:+lang/javascript/README.org][javascript]] - [[file:+lang/jr/README.org][jr]] +- [[file:+lang/json/README.org][json]] +- [[file:+lang/jsonnet/README.org][jsonnet]] +- [[file:+lang/julia/README.org][julia]] +- [[file:+lang/kotlin/README.org][kotlin]] - [[file:+lang/latex/README.org][latex]] - [[file:+lang/lua/README.org][lua]] +- [[file:+lang/major-modes/README.org][major-modes]] - [[file:+lang/markdown/README.org][markdown]] - [[file:+lang/nim/README.org][nim]] - [[file:+lang/ocaml/README.org][ocaml]] - [[file:+lang/octave/README.org][octave]] +- [[file:+lang/pact/README.org][pact]] - [[file:+lang/perl5/README.org][perl5]] - [[file:+lang/perl6/README.org][perl6]] - [[file:+lang/php/README.org][php]] @@ -117,6 +148,7 @@ - [[file:+lang/rust/README.org][rust]] - [[file:+lang/scala/README.org][scala]] - [[file:+lang/scheme/README.org][scheme]] +- [[file:+lang/semantic-web/README.org][semantic-web]] - [[file:+lang/shell-scripts/README.org][shell-scripts]] - [[file:+lang/sml/README.org][sml]] - [[file:+lang/sql/README.org][sql]] @@ -127,9 +159,13 @@ - [[file:+lang/yaml/README.org][yaml]] * Misc +- [[file:+misc/copy-as-format/README.org][copy-as-format]] - [[file:+misc/nlinum/README.org][nlinum]] - [[file:+misc/parinfer/README.org][parinfer]] +* Music +- [[file:+music/spotify/README.org][spotify]] + * Operating systems - [[file:+os/nixos/README.org][nixos]] - [[file:+os/osx/README.org][osx]] @@ -137,6 +173,14 @@ * Pair programming - [[file:+pair-programming/floobits/README.org][floobits]] +* Readers +- [[file:+readers/dash/README.org][dash]] +- [[file:+readers/deft/README.org][deft]] +- [[file:+readers/elfeed/README.org][elfeed]] +- [[file:+readers/epub/README.org][epub]] +- [[file:+readers/pdf/README.org][pdf]] +- [[file:+readers/speed-reading/README.org][speed-reading]] + * Source control - [[file:+source-control/git/README.org][git]] - [[file:+source-control/github/README.org][github]] @@ -144,7 +188,20 @@ - [[file:+source-control/version-control/README.org][version-control]] * Spacemacs distribution layers +- [[file:+spacemacs/spacemacs-completion/README.org][spacemacs-completion]] +- [[file:+spacemacs/spacemacs-defaults/README.org][spacemacs-defaults]] +- [[file:+spacemacs/spacemacs-editing/README.org][spacemacs-editing]] +- [[file:+spacemacs/spacemacs-editing-visual/README.org][spacemacs-editing-visual]] +- [[file:+spacemacs/spacemacs-evil/README.org][spacemacs-evil]] +- [[file:+spacemacs/spacemacs-language/README.org][spacemacs-language]] +- [[file:+spacemacs/spacemacs-layouts/README.org][spacemacs-layouts]] +- [[file:+spacemacs/spacemacs-misc/README.org][spacemacs-misc]] +- [[file:+spacemacs/spacemacs-modeline/README.org][spacemacs-modeline]] +- [[file:+spacemacs/spacemacs-navigation/README.org][spacemacs-navigation]] +- [[file:+spacemacs/spacemacs-org/README.org][spacemacs-org]] +- [[file:+spacemacs/spacemacs-project/README.org][spacemacs-project]] - [[file:+spacemacs/spacemacs-purpose/README.org][spacemacs-purpose]] +- [[file:+spacemacs/spacemacs-visual/README.org][spacemacs-visual]] * Tags - [[file:+tags/cscope/README.org][cscope]] @@ -157,21 +214,23 @@ * Tools - [[file:+tools/ansible/README.org][ansible]] +- [[file:+tools/bm/README.org][bm]] - [[file:+tools/cfengine/README.org][cfengine]] - [[file:+tools/chrome/README.org][chrome]] - [[file:+tools/cmake/README.org][cmake]] - [[file:+tools/command-log/README.org][command-log]] -- [[file:+tools/dash/README.org][dash]] - [[file:+tools/debug/README.org][debug]] -- [[file:+tools/deft/README.org][deft]] - [[file:+tools/docker/README.org][docker]] - [[file:+tools/fasd/README.org][fasd]] - [[file:+tools/finance/README.org][finance]] - [[file:+tools/geolocation/README.org][geolocation]] - [[file:+tools/imenu-list/README.org][imenu-list]] +- [[file:+tools/lsp/README.org][lsp]] - [[file:+tools/nginx/README.org][nginx]] +- [[file:+tools/node/README.org][node]] - [[file:+tools/pandoc/README.org][pandoc]] -- [[file:+tools/pdf-tools/README.org][pdf-tools]] +- [[file:+tools/pass/README.org][pass]] +- [[file:+tools/prettier/README.org][prettier]] - [[file:+tools/prodigy/README.org][prodigy]] - [[file:+tools/puppet/README.org][puppet]] - [[file:+tools/ranger/README.org][ranger]] @@ -179,27 +238,26 @@ - [[file:+tools/restclient/README.org][restclient]] - [[file:+tools/salt/README.org][salt]] - [[file:+tools/shell/README.org][shell]] -- [[file:+tools/speed-reading/README.org][speed-reading]] - [[file:+tools/sphinx/README.org][sphinx]] - [[file:+tools/systemd/README.org][systemd]] +- [[file:+tools/tern/README.org][tern]] - [[file:+tools/terraform/README.org][terraform]] - [[file:+tools/tmux/README.org][tmux]] +- [[file:+tools/transmission/README.org][transmission]] - [[file:+tools/vagrant/README.org][vagrant]] +- [[file:+tools/web-beautify/README.org][web-beautify]] +- [[file:+tools/xclipboard/README.org][xclipboard]] - [[file:+tools/ycmd/README.org][ycmd]] * Vim -- [[file:+vim/evil-cleverparens/README.org][evil-cleverparens]] - [[file:+vim/evil-commentary/README.org][evil-commentary]] - [[file:+vim/evil-snipe/README.org][evil-snipe]] - [[file:+vim/vim-empty-lines/README.org][vim-empty-lines]] -- [[file:+vim/vim-powerline/README.org][vim-powerline]] - [[file:+vim/vinegar/README.org][vinegar]] * Web services - [[file:+web-services/confluence/README.org][confluence]] -- [[file:+web-services/elfeed/README.org][elfeed]] - [[file:+web-services/evernote/README.org][evernote]] - [[file:+web-services/search-engine/README.org][search-engine]] -- [[file:+web-services/spotify/README.org][spotify]] - [[file:+web-services/twitter/README.org][twitter]] - [[file:+web-services/wakatime/README.org][wakatime]]