aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/modules/ROOT/pages/configuration.adoc4
-rw-r--r--doc/modules/ROOT/pages/contributing.adoc2
-rw-r--r--doc/modules/ROOT/pages/faq.adoc2
-rw-r--r--doc/modules/ROOT/pages/installation.adoc2
-rw-r--r--doc/modules/ROOT/pages/support.adoc2
-rw-r--r--doc/modules/ROOT/pages/troubleshooting.adoc4
-rw-r--r--doc/modules/ROOT/pages/usage.adoc4
7 files changed, 14 insertions, 6 deletions
diff --git a/doc/modules/ROOT/pages/configuration.adoc b/doc/modules/ROOT/pages/configuration.adoc
index 2f3d128..27ce89f 100644
--- a/doc/modules/ROOT/pages/configuration.adoc
+++ b/doc/modules/ROOT/pages/configuration.adoc
@@ -80,7 +80,7 @@ For non-VCS projects Projectile will invoke whatever is in `projectile-generic-c
find . -type f -print0
----
-TIP: It's a great idea to install [fd](https://github.com/sharkdp/fd) which is much faster than `find`.
+TIP: It's a great idea to install https://github.com/sharkdp/fd[fd] which is much faster than `find`.
If `fd` is found, projectile will use as a replacement for `find`.
== Sorting
@@ -294,7 +294,7 @@ extremely popular and it is built into Emacs.
TIP: As already noted above if you're going to use the `ido` completion it's
**extremely highly** recommended that you install the optional
- [flx-ido package](https://github.com/lewang/flx), which provides a much
+ https://github.com/lewang/flx[flx-ido package], which provides a much
more powerful alternative to `ido`'s built-in `flex` matching.
=== Ivy (recommended)
diff --git a/doc/modules/ROOT/pages/contributing.adoc b/doc/modules/ROOT/pages/contributing.adoc
index 875f9c0..70c97be 100644
--- a/doc/modules/ROOT/pages/contributing.adoc
+++ b/doc/modules/ROOT/pages/contributing.adoc
@@ -1,3 +1,5 @@
+= Contributing
+
== Issues
Report issues and suggest features and improvements on the
diff --git a/doc/modules/ROOT/pages/faq.adoc b/doc/modules/ROOT/pages/faq.adoc
index 5273539..02699af 100644
--- a/doc/modules/ROOT/pages/faq.adoc
+++ b/doc/modules/ROOT/pages/faq.adoc
@@ -1,3 +1,5 @@
+= Frequently Asked Questions
+
== Why did you name it Projectile?
I wanted a name that's not as boring as `project.el` and implies that your
diff --git a/doc/modules/ROOT/pages/installation.adoc b/doc/modules/ROOT/pages/installation.adoc
index dfce96b..74ffdb4 100644
--- a/doc/modules/ROOT/pages/installation.adoc
+++ b/doc/modules/ROOT/pages/installation.adoc
@@ -43,7 +43,7 @@ and serious regressions there are usually fixed pretty quickly.
TIP: If you don't want to (or can't) wait for MELPA to rebuild Projectile,
you can easily build and install an up-to-date MELPA package locally yourself. Check out
- [this article](http://emacsredux.com/blog/2015/05/10/building-melpa-packages-locally/)
+ http://emacsredux.com/blog/2015/05/10/building-melpa-packages-locally/[this article]
for details on the subject.
Generally, users of the non-adventurous kind are advised to stick
diff --git a/doc/modules/ROOT/pages/support.adoc b/doc/modules/ROOT/pages/support.adoc
index 33389d6..d2ca66f 100644
--- a/doc/modules/ROOT/pages/support.adoc
+++ b/doc/modules/ROOT/pages/support.adoc
@@ -1,3 +1,5 @@
+= Support
+
Projectile currently has several official & unofficial support channels.
For questions, suggestions and support refer to one of them. Please, don't
diff --git a/doc/modules/ROOT/pages/troubleshooting.adoc b/doc/modules/ROOT/pages/troubleshooting.adoc
index 20ebcb5..0c75ecb 100644
--- a/doc/modules/ROOT/pages/troubleshooting.adoc
+++ b/doc/modules/ROOT/pages/troubleshooting.adoc
@@ -13,7 +13,7 @@ Emacs features a super powerful built-in
http://www.gnu.org/software/emacs/manual/html_node/elisp/Edebug.html[Emacs Lisp debugger]
and using it is the best way to diagnose problems of any kind.
-TIP: Here's a [great crash course](https://www.youtube.com/watch?v=odkYXXYOxpo) on
+TIP: Here's a https://www.youtube.com/watch?v=odkYXXYOxpo[great crash course] on
using the debugger.
To debug some command you need to do the following:
@@ -43,6 +43,8 @@ TIP: If you intend to share the profiling results with someone it's a good idea
== Commonly encountered problems (and how to solve them)
+=== Using some command causes Emacs to freeze for a while
+
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:
diff --git a/doc/modules/ROOT/pages/usage.adoc b/doc/modules/ROOT/pages/usage.adoc
index 207d728..8d8d9e3 100644
--- a/doc/modules/ROOT/pages/usage.adoc
+++ b/doc/modules/ROOT/pages/usage.adoc
@@ -18,8 +18,8 @@ is automatically going to check for projects:
----
TIP: If you're going to use the default `ido` completion it's **extremely
-highly** recommended that you install the optional [flx-ido
-package](https://github.com/lewang/flx), which provides a much more powerful
+highly** recommended that you install the optional
+https://github.com/lewang/flx[flx-ido package], which provides a much more powerful
alternative to `ido`'s built-in `flex` matching.
Check out the xref:configuration.adoc["Configuration"] section of the manual