Use proper markup for code in readmes
By convention, code markup (`~`) is reserved for keybindings in Org-based documentation in Spacemacs. Verbatim markup (`=`) is reserved for code and other code-like things. So change several readmes to reflect this convention. Use verbatim markup for things like (non-exhaustive list): - Emacs Lisp functions, modes, buffers, etc. - Environment variables - Directory paths - Code in general
This commit is contained in:
Kristoffer Haugsbakk
Eivind Fonn
parent
249c3b87b0
commit
79ed1a6b4b
|
|
@ -99,5 +99,5 @@ read that in =:password=.
|
|||
|
||||
* Spacemacs Layout Support
|
||||
ERC buffers are added automatically to the default layout for ERC controlled by
|
||||
the variable ~erc-spacemacs-layout-name~ (defaults to "@ERC") and the default
|
||||
binding ("E") is controlled by ~erc-spacemacs-layout-binding~
|
||||
the variable =erc-spacemacs-layout-name= (defaults to "@ERC") and the default
|
||||
binding ("E") is controlled by =erc-spacemacs-layout-binding=
|
||||
|
|
|
|||
|
|
@ -189,5 +189,5 @@ The rcirc documentation can be found [[http://www.gnu.org/software/emacs/manual/
|
|||
* Spacemacs Layout Support
|
||||
|
||||
RCIRC buffers are added automatically to the default layout for RCIRC controlled by
|
||||
the variable ~rcirc-spacemacs-layout-name~ (defaults to "@RCIRC") and the default
|
||||
binding ("i") is controlled by ~rcirc-spacemacs-layout-binding~
|
||||
the variable =rcirc-spacemacs-layout-name= (defaults to "@RCIRC") and the default
|
||||
binding ("i") is controlled by =rcirc-spacemacs-layout-binding=
|
||||
|
|
|
|||
|
|
@ -177,7 +177,7 @@ Many spacemacs layers (e.g., python, html, haskell) configure company mode
|
|||
backends to provide mode-specific completion. These modes will include
|
||||
completion backends specified in the `spacemacs-default-company-backends`
|
||||
variable. The defaults should work well, but you can configure this variable in
|
||||
your ~.spacemacs~ file with (e.g.)
|
||||
your =.spacemacs= file with (e.g.)
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
(setq-default
|
||||
dotspacemacs-configuration-layers
|
||||
|
|
|
|||
|
|
@ -152,7 +152,7 @@ instead (see [[http://www.djcbsoftware.nl/code/mu/mu4e/Contexts.html#Contexts][m
|
|||
#+END_SRC
|
||||
|
||||
** Notifications
|
||||
~mu4e-alert~ is an extension that provides desktop notifications and adds the
|
||||
=mu4e-alert= is an extension that provides desktop notifications and adds the
|
||||
count of unread messages to the modeline.
|
||||
|
||||
[[https://raw.githubusercontent.com/iqbalansari/mu4e-alert/master/screenshots/mu4e-alert-in-action.png]]
|
||||
|
|
@ -162,7 +162,7 @@ For an extended documentation of the available customizations please refer to
|
|||
|
||||
*** OS notifications
|
||||
To enable notifications about new messages, add the following line to your
|
||||
~dotspacemacs/user-config~:
|
||||
=dotspacemacs/user-config=:
|
||||
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
(setq mu4e-enable-notifications t)
|
||||
|
|
@ -175,9 +175,9 @@ or use layer variables when you add the layer to
|
|||
(mu4e :variables mu4e-enable-notifications t)
|
||||
#+END_SRC
|
||||
|
||||
By default, notifications will be shown in the ~*Messages*~ buffer. To enable
|
||||
By default, notifications will be shown in the =*Messages*= buffer. To enable
|
||||
desktop notifications about new messages, add the following lines to
|
||||
your ~dotspacemacs/user-config~, according to your operating system and the
|
||||
your =dotspacemacs/user-config=, according to your operating system and the
|
||||
installed libraries:
|
||||
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
|
|
@ -192,7 +192,7 @@ installed libraries:
|
|||
|
||||
*** Mode-line notifications
|
||||
To enable mode-line display about new messages, add the following line to
|
||||
your ~dotspacemacs/user-config~:
|
||||
your =dotspacemacs/user-config=:
|
||||
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
(setq mu4e-enable-mode-line t)
|
||||
|
|
|
|||
|
|
@ -116,7 +116,7 @@ More info regarding installation of nREPL middleware can be found here:
|
|||
|
||||
* Key Bindings
|
||||
** Working with clojure files (barfage, slurpage & more)
|
||||
Spacemacs comes with a special ~lisp-state~ for working with lisp code that
|
||||
Spacemacs comes with a special =lisp-state= for working with lisp code that
|
||||
supports slurpage, barfage and more tools you'll likely want when working with
|
||||
lisp.
|
||||
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ of Common Lisp, you can specify it in your =~/.spacemacs=
|
|||
|
||||
* Key Bindings
|
||||
** Working with lisp files (barfage, slurpage & more)
|
||||
Spacemacs comes with a special ~lisp-state~ for working with lisp code that
|
||||
Spacemacs comes with a special =lisp-state= for working with lisp code that
|
||||
supports slurpage, barfage and more tools you'll likely want when working with
|
||||
lisp.
|
||||
|
||||
|
|
|
|||
|
|
@ -50,11 +50,11 @@ add =elm= to the existing =dotspacemacs-configuration-layers= list in this
|
|||
file.
|
||||
|
||||
** Elm Platform
|
||||
The ~elm-platform~ is a bundle of tools, including the ~elm-compiler~,
|
||||
~elm-make~, ~elm-reactor~, ~elm-repl~ and ~elm-package~.
|
||||
The =elm-platform= is a bundle of tools, including the =elm-compiler=,
|
||||
=elm-make=, =elm-reactor=, =elm-repl= and =elm-package=.
|
||||
|
||||
Depending on the method of installation, the ~elm-mode~ package would need to be
|
||||
able to access commands such as ~elm-reactor~ or ~elm-make~.
|
||||
Depending on the method of installation, the =elm-mode= package would need to be
|
||||
able to access commands such as =elm-reactor= or =elm-make=.
|
||||
|
||||
*** OS X and Windows installers
|
||||
Official installers for these operating systems are available from:
|
||||
|
|
@ -66,13 +66,13 @@ certain operating system and architectures.
|
|||
#+BEGIN_SRC sh
|
||||
npm install --global elm
|
||||
#+END_SRC
|
||||
Also, note that you might need to set the ~ELM_HOME~ environment variables to
|
||||
Also, note that you might need to set the =ELM_HOME= environment variables to
|
||||
the corresponding directory created by the installer.
|
||||
|
||||
If you are facing problems with previewing a buffer with ~elm-reactor~ ensure
|
||||
If you are facing problems with previewing a buffer with =elm-reactor= ensure
|
||||
that the absolute path of the npm global bin file is on your path within emacs
|
||||
|
||||
OS X Users facing problems with ~elm-reactor~ failing to properly install or
|
||||
OS X Users facing problems with =elm-reactor= failing to properly install or
|
||||
run, see this issue [[https://github.com/kevva/elm-bin/issues/28][https://github.com/kevva/elm-bin/issues/28]].
|
||||
|
||||
*** Source code
|
||||
|
|
@ -80,14 +80,14 @@ To build from source, see instructions here:
|
|||
[[https://github.com/elm-lang/elm-platform][https://github.com/elm-lang/elm-platform]]
|
||||
|
||||
** elm-oracle
|
||||
~elm-oracle~ can be used to show type signatures and docs for tokens under the
|
||||
=elm-oracle= can be used to show type signatures and docs for tokens under the
|
||||
cursor and provide support for auto-completion, but it is not part of the
|
||||
standard elm-platform.
|
||||
|
||||
Both the "company" and "auto-complete" backends are supported, but this layer
|
||||
is configured with company.
|
||||
|
||||
To install ~elm-oracle~, install ~node.js~ and ~npm~, then
|
||||
To install =elm-oracle=, install =node.js= and =npm=, then
|
||||
run this command:
|
||||
|
||||
#+BEGIN_SRC sh
|
||||
|
|
@ -95,13 +95,13 @@ run this command:
|
|||
#+END_SRC
|
||||
|
||||
** elm-format
|
||||
~elm-format~ can be used to format elm code according to a standard set of
|
||||
=elm-format= can be used to format elm code according to a standard set of
|
||||
rules.
|
||||
|
||||
To install ~elm-format~ follow the the instructions for the version of elm
|
||||
To install =elm-format= follow the the instructions for the version of elm
|
||||
installed: https://github.com/avh4/elm-format
|
||||
|
||||
Also, note that if you use homebrew to install ~elm-format~ the installed exe
|
||||
Also, note that if you use homebrew to install =elm-format= the installed exe
|
||||
has a version suffix, the installed command name can be set in your
|
||||
=~/spacemacs=:
|
||||
|
||||
|
|
@ -113,20 +113,20 @@ has a version suffix, the installed command name can be set in your
|
|||
* Basic usage tips
|
||||
** Compilation
|
||||
To control the name of the compiled JavaScript file, use ~SPC m c B~ instead of
|
||||
~SPC m c b~. This will overwrite the ~--output~ parameter of ~elm-make~ to
|
||||
~[buffer-name].js~ instead of the default.
|
||||
~SPC m c b~. This will overwrite the =--output= parameter of =elm-make= to
|
||||
=[buffer-name].js= instead of the default.
|
||||
|
||||
** Reactor
|
||||
~elm-reactor~ is an interactive development tool, used to develop and debug Elm
|
||||
=elm-reactor= is an interactive development tool, used to develop and debug Elm
|
||||
programs. It will automatically compile an Elm program, and run it in the
|
||||
browser, with editor agnostic support for hot-swapping and time-travel
|
||||
debugging.
|
||||
|
||||
To preview ~Main.elm~, press ~C-c C-m~ (or ~SPC m R m~).
|
||||
To preview =Main.elm=, press ~C-c C-m~ (or ~SPC m R m~).
|
||||
Alternatively, to preview from buffer, press ~C-u C-c C-n~ (or ~SPC m R
|
||||
n~). To preview in debug mode, prefix with ~C-u~ (or ~SPC u~).
|
||||
|
||||
By default, ~elm-reactor~ with launch with its own generated index.html. To use
|
||||
By default, =elm-reactor= with launch with its own generated index.html. To use
|
||||
a custom html, you'd need to load the debuger excplictly and use an http daemon
|
||||
to serve your custom file.
|
||||
|
||||
|
|
@ -141,7 +141,7 @@ can be controlled by passing in these variables in your =~/.spacemacs=:
|
|||
|
||||
** On save usage
|
||||
*** Imports sort
|
||||
Set ~elm-sort-imports-on-save~ to ~t~ to sort the imports in the current file on
|
||||
Set =elm-sort-imports-on-save= to =t= to sort the imports in the current file on
|
||||
every save.
|
||||
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
|
|
@ -149,7 +149,7 @@ every save.
|
|||
#+END_SRC
|
||||
|
||||
*** File format
|
||||
Set ~elm-format-on-save~ to ~t~ to format current file on every save.
|
||||
Set =elm-format-on-save= to =t= to format current file on every save.
|
||||
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
(elm :variables elm-format-on-save t)
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ feature use this line in your =dotspacemacs/user-config= function.
|
|||
You can also exclude the =auto-compile= package.
|
||||
|
||||
* Working with lisp files (barfage, slurpage & more)
|
||||
Spacemacs comes with a special ~lisp-state~ for working with lisp code that
|
||||
Spacemacs comes with a special =lisp-state= for working with lisp code that
|
||||
supports slurpage, barfage and more tools you'll likely want when working with
|
||||
lisp.
|
||||
|
||||
|
|
|
|||
|
|
@ -302,8 +302,8 @@ ghc-mod commands are prefixed by ~SPC m m~:
|
|||
|-------------+-------------------------------------------|
|
||||
| ~SPC t~ | insert template |
|
||||
| ~SPC m m u~ | insert template with holes |
|
||||
| ~SPC m m a~ | select one of possible cases (~ghc-auto~) |
|
||||
| ~SPC m m f~ | replace a hole (~ghc-refine~) |
|
||||
| ~SPC m m a~ | select one of possible cases (=ghc-auto=) |
|
||||
| ~SPC m m f~ | replace a hole (=ghc-refine=) |
|
||||
| ~SPC m m e~ | expand template haskell |
|
||||
| ~SPC m m n~ | go to next type hole |
|
||||
| ~SPC m m p~ | go to previous type hole |
|
||||
|
|
|
|||
|
|
@ -48,4 +48,4 @@ documents, define a value for =org-plantuml-jar-path= in your =~/.spacemacs=.
|
|||
| Key Binding | Description |
|
||||
|--------------------------+-------------------------------------------------------|
|
||||
| ~SPC m c c~ or ~C-c C-c~ | Build diagram from the text in the current buffer |
|
||||
| ~SPC m c o~ | Set the output type (~unicode text~, ~svg~, or ~png~) |
|
||||
| ~SPC m c o~ | Set the output type (=unicode text=, =svg=, or =png=) |
|
||||
|
|
|
|||
|
|
@ -72,7 +72,7 @@ To fix this, install the =anaconda-mode= [[https://github.com/proofit404/anacond
|
|||
Source: https://github.com/proofit404/anaconda-mode#issues
|
||||
|
||||
If you are facing errors such as "Unable to run anaconda-mode server", try
|
||||
setting your ~PYTHONPATH~ as explained at
|
||||
setting your =PYTHONPATH= as explained at
|
||||
https://github.com/proofit404/anaconda-mode#pythonpath
|
||||
|
||||
*** Syntax checking
|
||||
|
|
@ -142,7 +142,7 @@ that hy is installed.
|
|||
A virtual environment provides isolation of your Python package versions. For a
|
||||
general overview see [[http://docs.python-guide.org/en/latest/dev/virtualenvs/][this site]]. [[http://virtualenvwrapper.readthedocs.io/en/latest/index.html][Virtualenvwrapper]] which is also explained in the
|
||||
previous link, is a program which manages your virtual environments in a central
|
||||
location set by the ~WORKON_HOME~ environment variable.
|
||||
location set by the =WORKON_HOME= environment variable.
|
||||
|
||||
Spacemacs integration of virtual environments and virtualenvwrapper is provided
|
||||
by the [[https://github.com/jorgenschaefer/pyvenv][pyvenv]] package. It provides the following keybindings:
|
||||
|
|
@ -151,7 +151,7 @@ by the [[https://github.com/jorgenschaefer/pyvenv][pyvenv]] package. It provides
|
|||
|-------------+-------------------------------------------------|
|
||||
| ~SPC m V a~ | activate a virtual environment in any directory |
|
||||
| ~SPC m V d~ | deactivate active virtual environment |
|
||||
| ~SPC m V w~ | work on virtual environment in ~WORKON_HOME~ |
|
||||
| ~SPC m V w~ | work on virtual environment in =WORKON_HOME= |
|
||||
|
||||
** Manage multiple Python versions with pyenv
|
||||
If you need multiple Python versions (e.g. Python 2 and Python 3) then take a
|
||||
|
|
@ -291,14 +291,14 @@ Send code to hy REPL commands:
|
|||
| ~SPC m h H~ | open documentation in =firefox= using [[https://github.com/tsgates/pylookup][pylookup]] |
|
||||
| ~SPC m v s~ | set a pyenv environment with [[https://github.com/pyenv/pyenv][pyenv]] |
|
||||
| ~SPC m v u~ | unset a pyenv environment with [[https://github.com/pyenv/pyenv][pyenv]] |
|
||||
| ~SPC m V w~ | work on virtual environment in ~WORKON_HOME~ |
|
||||
| ~SPC m V w~ | work on virtual environment in =WORKON_HOME= |
|
||||
| ~SPC m V a~ | activate a virtual environment in any directory |
|
||||
| ~SPC m V d~ | deactivate active virtual environment |
|
||||
|
||||
* Configuration
|
||||
** Fill column
|
||||
If you want to customize the fill column value, use something like this inside
|
||||
the ~user-init~ function in your ~.spacemacs~:
|
||||
the =user-init= function in your =.spacemacs=:
|
||||
|
||||
#+BEGIN_SRC elisp
|
||||
(setq-default dotspacemacs-configuration-layers '(
|
||||
|
|
|
|||
|
|
@ -19,9 +19,9 @@ following features:
|
|||
|
||||
- Syntax highlighting
|
||||
- Indentation
|
||||
- Code navigation using ~imenu~ (built-in)
|
||||
- Automatic syntax checking with ~flycheck~ (available with the
|
||||
~syntax-checking~ layer)
|
||||
- Code navigation using =imenu= (built-in)
|
||||
- Automatic syntax checking with =flycheck= (available with the
|
||||
=syntax-checking= layer)
|
||||
|
||||
* Install
|
||||
First check that you are able to run this from the command line:
|
||||
|
|
@ -36,8 +36,8 @@ need to add =swift= to the existing =dotspacemacs-configuration-layers= list in
|
|||
this file.
|
||||
|
||||
* Usage information
|
||||
Unless configured by the user, the REPL will be invoked using the command ~xcrun
|
||||
swift~.
|
||||
Unless configured by the user, the REPL will be invoked using the command =xcrun
|
||||
swift=.
|
||||
You can launch the REPL using the keybinding ~SPC m s s~ (or ~C-c C-z~).
|
||||
The universal prefix ~SPC u~ (~C-u~) may be used to modify command invocation.
|
||||
|
||||
|
|
@ -51,7 +51,7 @@ The universal prefix ~SPC u~ (~C-u~) may be used to modify command invocation.
|
|||
| ~SPC m s r~ | swift-mode-send-region |
|
||||
|
||||
Notes:
|
||||
1. ~swift-mode-run-repl~ will run or switch to an existing REPL.
|
||||
1. =swift-mode-run-repl= will run or switch to an existing REPL.
|
||||
2. To edit the command invocation, prefix with ~SPC u~ (or ~C-u~).
|
||||
3. Emacs key bindings in use are the those set by the package.
|
||||
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ file.
|
|||
|
||||
* Usage
|
||||
** TRAMP access to docker containers
|
||||
This relies on the [[https://github.com/emacs-pe/docker-tramp.el][docker-tramp]] package which uses ~docker exec~ available in
|
||||
This relies on the [[https://github.com/emacs-pe/docker-tramp.el][docker-tramp]] package which uses =docker exec= available in
|
||||
docker versions > 1.3.
|
||||
|
||||
=docker-tramp= adds a new prefix =/docker:= that you can use with ~SPC f f~,
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ the documentation states.
|
|||
|
||||
If you use a Debian based system such as Ubuntu, you can skip this step, as
|
||||
=pdf-tools= installation asks whether you want it to try to download
|
||||
automatically all dependencies using ~apt-get~.
|
||||
automatically all dependencies using =apt-get=.
|
||||
|
||||
** Dotfile
|
||||
After installing the dependencies, add this to your =~/.spacemacs=.
|
||||
|
|
@ -60,11 +60,11 @@ be able to see /PDFView/ (instead of /DocView/) on the spaceline after opening a
|
|||
pdf file.
|
||||
|
||||
If the compilation run successfully but you get
|
||||
~Error (use-package): pdf-tools :config: No executable `epdfinfo' found~,
|
||||
=Error (use-package): pdf-tools :config: No executable `epdfinfo' found=,
|
||||
try restarting Spacemacs ([[https://github.com/politza/pdf-tools/issues/31][issue]]).
|
||||
|
||||
If the compilation does not run successfully, you should confirm whether all
|
||||
dependencies are properly installed and run the command ~pdf-tools-install~.
|
||||
dependencies are properly installed and run the command =pdf-tools-install=.
|
||||
|
||||
* Usage
|
||||
Use ~SPC m .~ to activate the pdf-tools transient state.
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ A nice video demonstration by the package author can be found [[https://www.yout
|
|||
- Boxes auto-adapt as text is inserted or deleted,
|
||||
- ~S-RET~ to continue a comment on the next line,
|
||||
- Kill/yank within the box,
|
||||
- Apparently works well with ancient ~filladpt-mode~ (see authors video).
|
||||
- Apparently works well with ancient =filladpt-mode= (see authors video).
|
||||
|
||||
* Install
|
||||
** Layer
|
||||
|
|
|
|||
Loading…
Reference in New Issue