branch: elpa/projectile
commit 19de9c3be248cb14489a3b84a7f3a069128c0066
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Add screenshots and animated demos to the docs
Illustrate the key features (find file, switch project, the dispatch
menu, the search/replace review buffers and named tasks) with scripted,
reproducible captures using vertico + marginalia and zenburn.
---
.../ROOT/assets/images/projectile-dispatch.png | Bin 0 -> 447122 bytes
.../ROOT/assets/images/projectile-find-file.gif | Bin 0 -> 436971 bytes
.../ROOT/assets/images/projectile-replace-review.gif | Bin 0 -> 271898 bytes
.../ROOT/assets/images/projectile-run-task.png | Bin 0 -> 99960 bytes
.../ROOT/assets/images/projectile-search-review.png | Bin 0 -> 412263 bytes
.../ROOT/assets/images/projectile-switch-project.png | Bin 0 -> 209115 bytes
doc/modules/ROOT/pages/tasks.adoc | 2 ++
doc/modules/ROOT/pages/usage.adoc | 19 +++++++++++++++++++
8 files changed, 21 insertions(+)
diff --git a/doc/modules/ROOT/assets/images/projectile-dispatch.png
b/doc/modules/ROOT/assets/images/projectile-dispatch.png
new file mode 100644
index 0000000000..b87d9288a1
Binary files /dev/null and
b/doc/modules/ROOT/assets/images/projectile-dispatch.png differ
diff --git a/doc/modules/ROOT/assets/images/projectile-find-file.gif
b/doc/modules/ROOT/assets/images/projectile-find-file.gif
new file mode 100644
index 0000000000..a5a74e3619
Binary files /dev/null and
b/doc/modules/ROOT/assets/images/projectile-find-file.gif differ
diff --git a/doc/modules/ROOT/assets/images/projectile-replace-review.gif
b/doc/modules/ROOT/assets/images/projectile-replace-review.gif
new file mode 100644
index 0000000000..b829f7c982
Binary files /dev/null and
b/doc/modules/ROOT/assets/images/projectile-replace-review.gif differ
diff --git a/doc/modules/ROOT/assets/images/projectile-run-task.png
b/doc/modules/ROOT/assets/images/projectile-run-task.png
new file mode 100644
index 0000000000..fb954a93b4
Binary files /dev/null and
b/doc/modules/ROOT/assets/images/projectile-run-task.png differ
diff --git a/doc/modules/ROOT/assets/images/projectile-search-review.png
b/doc/modules/ROOT/assets/images/projectile-search-review.png
new file mode 100644
index 0000000000..75923c01b1
Binary files /dev/null and
b/doc/modules/ROOT/assets/images/projectile-search-review.png differ
diff --git a/doc/modules/ROOT/assets/images/projectile-switch-project.png
b/doc/modules/ROOT/assets/images/projectile-switch-project.png
new file mode 100644
index 0000000000..06d5b695d9
Binary files /dev/null and
b/doc/modules/ROOT/assets/images/projectile-switch-project.png differ
diff --git a/doc/modules/ROOT/pages/tasks.adoc
b/doc/modules/ROOT/pages/tasks.adoc
index 2628e2c29d..f0b879feaa 100644
--- a/doc/modules/ROOT/pages/tasks.adoc
+++ b/doc/modules/ROOT/pages/tasks.adoc
@@ -64,6 +64,8 @@ task gets its own compilation buffer, named
`+*projectile-task: NAME*+` (with
the project name appended when `projectile-per-project-compilation-buffer` is
non-nil), so several tasks can run side by side.
+image::projectile-run-task.png[projectile-run-task prompting for one of the
project's tasks]
+
A task's command is either a shell command string or a function called with no
arguments (with `default-directory` at the project root) that returns one.
diff --git a/doc/modules/ROOT/pages/usage.adoc
b/doc/modules/ROOT/pages/usage.adoc
index 6885c1f790..37a3c7420f 100644
--- a/doc/modules/ROOT/pages/usage.adoc
+++ b/doc/modules/ROOT/pages/usage.adoc
@@ -37,6 +37,16 @@ NOTE: The examples below (and throughout this manual) use
the `s-p` prefix.
** package project (kbd:[s-p c p])
** run project (kbd:[s-p c r])
+Here's `projectile-find-file` (kbd:[s-p f]) in action, narrowing the project's
+files down with a few keystrokes (shown with `vertico` and `marginalia`, which
+Projectile's completion categories integrate with nicely):
+
+image::projectile-find-file.gif[projectile-find-file narrowing the project's
files in the minibuffer]
+
+And this is what switching projects (kbd:[s-p p]) looks like:
+
+image::projectile-switch-project.png[projectile-switch-project prompting for
one of the known projects]
+
There are many more commands, covered in the sections below, but the basics
can get you pretty far.
== Basic setup
@@ -208,6 +218,11 @@ command honors full Emacs regexp syntax (e.g. symbol
boundaries like
`\_<foo\_>`) and the preview reflects the exact text that will be edited,
including any unsaved changes in already-open buffers.
+Here's the whole flow - gather the matches, toggle off the ones you want to
+keep, apply the rest:
+
+image::projectile-replace-review.gif[projectile-replace-review toggling
matches off and applying the rest]
+
Every match starts enabled (shown as `[X]`); toggle the ones you don't want
off (`[ ]`) and apply only the rest, in any order. The results buffer
supports these keys:
@@ -319,6 +334,8 @@ buffer, grouped by file, one `LINE:COL: CONTEXT` line per
match with the
matched span highlighted. There is no replacement, no per-match toggle and
no apply: the buffer never edits your files.
+image::projectile-search-review.png[The projectile-search results buffer,
grouped by file]
+
The results buffer supports these keys:
|===
@@ -429,6 +446,8 @@ menu than memorize a lot of keybindings. The menu keys
match the command map
(e.g. kbd:[f] to find a file, kbd:[c c] to compile, kbd:[s g] to grep). Invoke
it with kbd:[s-p m].
+image::projectile-dispatch.png[The projectile-dispatch menu]
+
It's also wired into project switching: press kbd:[C-u s-p p] and Projectile
opens the dispatch menu after you select a project, so you can run any command
in the project you just switched to. (The same happens if you set
