[Docs] Fix keybindings markup

bbatsov · bbatsov · commit 22925ddb8c29 · 2020-05-29T11:18:23.000+03:00
diff --git a/doc/modules/ROOT/pages/configuration.adoc b/doc/modules/ROOT/pages/configuration.adoc
@@ -141,12 +141,12 @@ To enable caching unconditionally use this snippet of code:
 (setq projectile-enable-caching t)
 ----
 
-At this point you can try out a Projectile command such as +++<kbd>+++s-p f+++</kbd>+++ (+++<kbd>+++M-x projectile-find-file RET+++</kbd>+++).
+At this point you can try out a Projectile command such as kbd:[s-p f] (kbd:[M-x projectile-find-file RET]).
 
-Running +++<kbd>+++C-u s-p f+++</kbd>+++ will invalidate the cache prior to
+Running kbd:[C-u s-p f] will invalidate the cache prior to
 prompting you for a file to jump to.
 
-Pressing +++<kbd>+++s-p z+++</kbd>+++ will add the currently visited file to the
+Pressing kbd:[s-p z] will add the currently visited file to the
 cache for current project. Generally files created outside Emacs will
 be added to the cache automatically the first time you open them.
 
@@ -205,7 +205,7 @@ By default, projectile does not include the current project in the list when
 switching projects. If you want to include the current project, customize
 variable `projectile-current-project-on-switch`.
 
-When running `projectile-switch-project` (+++<kbd>+++s-p p+++</kbd>+++) Projectile invokes
+When running `projectile-switch-project` (kbd:[s-p p]) Projectile invokes
 the command specified in `projectile-switch-project-action` (by default it is
 `projectile-find-file`).
 
diff --git a/doc/modules/ROOT/pages/contributing.adoc b/doc/modules/ROOT/pages/contributing.adoc
@@ -79,4 +79,4 @@ Run all tests with:
 $ make test
 ----
 
-Tests should run fine in `shell-mode` or `term-mode`. It's also possible to use +++<kbd>+++M-x+++</kbd>+++ `compile` (or `helm-make`).
+Tests should run fine in `shell-mode` or `term-mode`. It's also possible to use kbd:[M-x] `compile` (or `helm-make`).
diff --git a/doc/modules/ROOT/pages/installation.adoc b/doc/modules/ROOT/pages/installation.adoc
@@ -9,7 +9,7 @@ The recommended way to install Projectile is via `package.el`.
 You'll need to have Emacs installed (preferably the latest stable
 release). If you're new to Emacs you might want to go through
 https://www.gnu.org/software/emacs/tour/index.html[the guided tour of Emacs]
-and the built-in tutorial (just press +++<kbd>+++C-h t+++</kbd>+++).
+and the built-in tutorial (just press kbd:[C-h t]).
 
 == Installation via package.el
 
@@ -20,7 +20,7 @@ and http://melpa.org[MELPA].
 
 You can install Projectile with the following command:
 
-+++<kbd>+++M-x package-install [RET] projectile [RET]+++</kbd>+++
+kbd:[M-x package-install [RET] projectile [RET]]
 
 or by adding this bit of Emacs Lisp code to your Emacs initialization file
 (`.emacs` or `init.el`):
@@ -33,7 +33,7 @@ or by adding this bit of Emacs Lisp code to your Emacs initialization file
 
 If the installation doesn't work try refreshing the package list:
 
-+++<kbd>+++M-x package-refresh-contents [RET]+++</kbd>+++
+kbd:[M-x package-refresh-contents [RET]]
 
 Keep in mind that MELPA packages are built automatically from
 the `master` branch, meaning bugs might creep in there from time to
@@ -106,7 +106,7 @@ releases of Projectile, you'd declare the following:
 ----
 
 After placing one of the above s-expressions, evaluate it, for it to take effect
-by entering: +++<kbd>+++C-x C-e+++</kbd>+++.
+by entering: kbd:[C-x C-e].
 
 For further configuration options with `use-package`, consult the
 official https://github.com/jwiegley/use-package[use-package repository].
@@ -119,7 +119,7 @@ the https://github.com/dimitri/el-get[el-get] package manager.
 Provided you've already installed `el-get` you can install Projectile with the
 following command:
 
-+++<kbd>+++M-x el-get-install [RET] projectile [RET]+++</kbd>+++
+kbd:[M-x el-get-install [RET] projectile [RET]]
 
 == Installation on Debian and Ubuntu
 
diff --git a/doc/modules/ROOT/pages/projects.adoc b/doc/modules/ROOT/pages/projects.adoc
@@ -482,7 +482,7 @@ function.  It could also be used to e.g. add such a function to a key
 map.
 
 You can also quickly visit or create the `dir-locals-file` with
-+++<kbd>+++s-p E+++</kbd>+++ (+++<kbd>+++M-x projectile-edit-dir-locals RET+++</kbd>+++).
+kbd:[s-p E] (kbd:[M-x projectile-edit-dir-locals RET]).
 
 Here are a few examples of how to use this feature with Projectile.
 
diff --git a/doc/modules/ROOT/pages/troubleshooting.adoc b/doc/modules/ROOT/pages/troubleshooting.adoc
@@ -5,7 +5,7 @@ problem.
 
 Generally, it's not a bad idea to configure Emacs to spit the backtrace on error
 (instead of just logging the error in the `*Messages*` buffer). You can toggle
-this behavior by using +++<kbd>+++M-x+++</kbd>+++ `toggle-debug-on-error`.
+this behavior by using kbd:[M-x] `toggle-debug-on-error`.
 
 == Debugging Projectile commands
 
@@ -18,11 +18,11 @@ TIP: Here's a https://www.youtube.com/watch?v=odkYXXYOxpo[great crash course] on
 
 To debug some command you need to do the following:
 
-* Figure out the name of the command you want to debug (e.g. by using +++<kbd>+++C-h k+++</kbd>+++
+* Figure out the name of the command you want to debug (e.g. by using kbd:[C-h k]
 to see which command is associated with some keybinding)
-* Find the source of the command (e.g. by using +++<kbd>+++M-x+++</kbd>+++ `find-function`
-+++<kbd>+++RET+++</kbd>+++ `function-name`)
-* Press +++<kbd>+++C-u C-M-x+++</kbd>+++ while in the body of the function
+* Find the source of the command (e.g. by using kbd:[M-x] `find-function`
+kbd:[RET] `function-name`)
+* Press kbd:[C-u C-M-x] while in the body of the function
 * Run the command again
 
 At this point you'll be dropped in the debugger and you can step forward until
@@ -34,9 +34,9 @@ Emacs comes with a https://www.gnu.org/software/emacs/manual/html_node/elisp/Pro
 profiler]. Using
 it is pretty simple:
 
-. Start it with +++<kbd>+++M-x+++</kbd>+++ `profiler-start`.
+. Start it with kbd:[M-x] `profiler-start`.
 . Invoke some commands.
-. Get the report with +++<kbd>+++M-x+++</kbd>+++ `profiler-report`.
+. Get the report with kbd:[M-x] `profiler-report`.
 
 TIP: If you intend to share the profiling results with someone it's a good idea to
  save the report buffer to a file with <kbd>C-x C-w</kbd>.
@@ -49,9 +49,9 @@ Sometimes a Projectile command might hang for a while (e.g. due to a bug or a
 configuration issue). Such problems are super annoying, but are relatively easy
 to debug. Here are a few steps you can take in such situations:
 
-* Do +++<kbd>+++M-x+++</kbd>+++ `toggle-debug-on-quit`
+* Do kbd:[M-x] `toggle-debug-on-quit`
 * Reproduce the problem
-* Hit +++<kbd>+++C-g+++</kbd>+++ around 10 seconds into the hang
+* Hit kbd:[C-g] around 10 seconds into the hang
 
 This will bring up a backtrace with the entire function stack, including
 function arguments. So you should be able to figure out what's going on (or at
diff --git a/doc/modules/ROOT/pages/usage.adoc b/doc/modules/ROOT/pages/usage.adoc
@@ -41,11 +41,11 @@ You can learn more about Projectile's notion of a project xref:projects.adoc[her
 
 You need to know only a handful of Projectile commands to start benefiting from it.
 
-* Find file in current project (+++<kbd>+++s-p f+++</kbd>+++)
-* Switch project (+++<kbd>+++s-p p+++</kbd>+++)
-* Grep in project (+++<kbd>+++s-p s g+++</kbd>+++)
-* Replace in project (+++<kbd>+++s-p r+++</kbd>+++)
-* Invoke a command via the Projectile Commander (+++<kbd>+++s-p m+++</kbd>+++)
+* Find file in current project (kbd:[s-p f])
+* Switch project (kbd:[s-p p])
+* Grep in project (kbd:[s-p s g])
+* Replace in project (kbd:[s-p r])
+* Invoke a command via the Projectile Commander (kbd:[s-p m])
 
 The next section lists many more commands, but the basics can get you pretty far.
 
@@ -61,160 +61,160 @@ Here's a list of the interactive Emacs Lisp functions, provided by Projectile:
 |===
 | Keybinding | Description
 
-| +++<kbd>+++s-p f+++</kbd>+++
+| kbd:[s-p f]
 | Display a list of all files in the project. With a prefix argument it will clear the cache first.
 
-| +++<kbd>+++s-p F+++</kbd>+++
+| kbd:[s-p F]
 | Display a list of all files in all known projects.
 
-| +++<kbd>+++s-p g+++</kbd>+++
+| kbd:[s-p g]
 | Display a list of all files at point in the project. With a prefix argument it will clear the cache first.
 
-| +++<kbd>+++s-p 4 f+++</kbd>+++
+| kbd:[s-p 4 f]
 | Jump to a project's file using completion and show it in another window.
 
-| +++<kbd>+++s-p 4 g+++</kbd>+++
+| kbd:[s-p 4 g]
 | Jump to a project's file based on context at point and show it in another window.
 
-| +++<kbd>+++s-p 5 f+++</kbd>+++
+| kbd:[s-p 5 f]
 | Jump to a project's file using completion and show it in another frame.
 
-| +++<kbd>+++s-p 5 g+++</kbd>+++
+| kbd:[s-p 5 g]
 | Jump to a project's file based on context at point and show it in another frame.
 
-| +++<kbd>+++s-p d+++</kbd>+++
+| kbd:[s-p d]
 | Display a list of all directories in the project. With a prefix argument it will clear the cache first.
 
-| +++<kbd>+++s-p 4 d+++</kbd>+++
+| kbd:[s-p 4 d]
 | Switch to a project directory and show it in another window.
 
-| +++<kbd>+++s-p 5 d+++</kbd>+++
+| kbd:[s-p 5 d]
 | Switch to a project directory and show it in another frame.
 
-| +++<kbd>+++s-p T+++</kbd>+++
+| kbd:[s-p T]
 | Display a list of all test files(specs, features, etc) in the project.
 
-| +++<kbd>+++s-p l+++</kbd>+++
+| kbd:[s-p l]
 | Display a list of all files in a directory (that's not necessarily a project)
 
-| +++<kbd>+++s-p s g+++</kbd>+++
+| kbd:[s-p s g]
 | Run grep on the files in the project.
 
-| +++<kbd>+++M-- s-p s g+++</kbd>+++
+| kbd:[M-- s-p s g]
 | Run grep on `projectile-grep-default-files` in the project.
 
-| +++<kbd>+++s-p v+++</kbd>+++
+| kbd:[s-p v]
 | Run `vc-dir` on the root directory of the project.
 
-| +++<kbd>+++s-p V+++</kbd>+++
+| kbd:[s-p V]
 | Browse dirty version controlled projects.
 
-| +++<kbd>+++s-p b+++</kbd>+++
+| kbd:[s-p b]
 | Display a list of all project buffers currently open.
 
-| +++<kbd>+++s-p 4 b+++</kbd>+++
+| kbd:[s-p 4 b]
 | Switch to a project buffer and show it in another window.
 
-| +++<kbd>+++s-p 5 b+++</kbd>+++
+| kbd:[s-p 5 b]
 | Switch to a project buffer and show it in another frame.
 
-| +++<kbd>+++s-p 4 C-o+++</kbd>+++
+| kbd:[s-p 4 C-o]
 | Display a project buffer in another window without selecting it.
 
-| +++<kbd>+++s-p a+++</kbd>+++
+| kbd:[s-p a]
 | Switch between files with the same name but different extensions.
 
-| +++<kbd>+++s-p 4 a+++</kbd>+++
+| kbd:[s-p 4 a]
 | Switch between files with the same name but different extensions in other window.
 
-| +++<kbd>+++s-p 5 a+++</kbd>+++
+| kbd:[s-p 5 a]
 | Switch between files with the same name but different extensions in other frame.
 
-| +++<kbd>+++s-p o+++</kbd>+++
+| kbd:[s-p o]
 | Runs `multi-occur` on all project buffers currently open.
 
-| +++<kbd>+++s-p r+++</kbd>+++
+| kbd:[s-p r]
 | Runs interactive query-replace on all files in the projects.
 
-| +++<kbd>+++s-p i+++</kbd>+++
+| kbd:[s-p i]
 | Invalidates the project cache (if existing).
 
-| +++<kbd>+++s-p R+++</kbd>+++
+| kbd:[s-p R]
 | Regenerates the projects `TAGS` file.
 
-| +++<kbd>+++s-p j+++</kbd>+++
+| kbd:[s-p j]
 | Find tag in project's `TAGS` file.
 
-| +++<kbd>+++s-p k+++</kbd>+++
+| kbd:[s-p k]
 | Kills all project buffers.
 
-| +++<kbd>+++s-p D+++</kbd>+++
+| kbd:[s-p D]
 | Opens the root of the project in `dired`.
 
-| +++<kbd>+++s-p 4 D+++</kbd>+++
+| kbd:[s-p 4 D]
 | Opens the root of the project in `dired` in another window.
 
-| +++<kbd>+++s-p 5 D+++</kbd>+++
+| kbd:[s-p 5 D]
 | Opens the root of the project in `dired` in another frame.
 
-| +++<kbd>+++s-p e+++</kbd>+++
+| kbd:[s-p e]
 | Shows a list of recently visited project files.
 
-| +++<kbd>+++s-p left+++</kbd>+++
+| kbd:[s-p left]
 | Switch to the previous project buffer.
 
-| +++<kbd>+++s-p right+++</kbd>+++
+| kbd:[s-p right]
 | Switch to the next project buffer.
 
-| +++<kbd>+++s-p E+++</kbd>+++
+| kbd:[s-p E]
 | Opens the root `dir-locals-file` of the project.
 
-| +++<kbd>+++s-p s s+++</kbd>+++
+| kbd:[s-p s s]
 | Runs `ag` on the project, performing a literal search. Requires the presence of `ag.el`. With a prefix argument it will perform a regex search.
 
-| +++<kbd>+++s-p !+++</kbd>+++
+| kbd:[s-p !]
 | Runs `shell-command` in the root directory of the project.
 
-| +++<kbd>+++s-p &+++</kbd>+++
+| kbd:[s-p &]
 | Runs `async-shell-command` in the root directory of the project.
 
-| +++<kbd>+++s-p C+++</kbd>+++
+| kbd:[s-p C]
 | Runs a standard configure command for your type of project.
 
-| +++<kbd>+++s-p c+++</kbd>+++
+| kbd:[s-p c]
 | Runs a standard compilation command for your type of project.
 
-| +++<kbd>+++s-p P+++</kbd>+++
+| kbd:[s-p P]
 | Runs a standard test command for your type of project.
 
-| +++<kbd>+++s-p t+++</kbd>+++
+| kbd:[s-p t]
 | Toggle between an implementation file and its test file.
 
-| +++<kbd>+++s-p 4 t+++</kbd>+++
+| kbd:[s-p 4 t]
 | Jump to implementation or test file in other window.
 
-| +++<kbd>+++s-p 5 t+++</kbd>+++
+| kbd:[s-p 5 t]
 | Jump to implementation or test file in other frame.
 
-| +++<kbd>+++s-p z+++</kbd>+++
+| kbd:[s-p z]
 | Adds the currently visited file to the cache.
 
-| +++<kbd>+++s-p p+++</kbd>+++
+| kbd:[s-p p]
 | Display a list of known projects you can switch to.
 
-| +++<kbd>+++s-p S+++</kbd>+++
+| kbd:[s-p S]
 | Save all project buffers.
 
-| +++<kbd>+++s-p m+++</kbd>+++
+| kbd:[s-p m]
 | Run the commander (an interface to run commands with a single key).
 
-| +++<kbd>+++s-p ESC+++</kbd>+++
+| kbd:[s-p ESC]
 | Switch to the most recently selected Projectile buffer.
 |===
 
 If you ever forget any of Projectile's keybindings just do a:
 
-+++<kbd>+++s-p C-h+++</kbd>+++
+kbd:[s-p C-h]
 
 It is possible to add additional commands to
 `projectile-command-map` referenced by the prefix key in
