branch: elpa/adoc-mode
commit 536b645cb48c220f5a0e85101712a785a4a47699
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Mention Flycheck's built-in asciidoctor checker in the README
---
README.adoc | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/README.adoc b/README.adoc
index a053c8f1b2..db874a2ee7 100644
--- a/README.adoc
+++ b/README.adoc
@@ -167,6 +167,18 @@ Pass extra arguments to every Asciidoctor invocation via
(setq adoc-asciidoctor-extra-args '("-a" "sectnums"))
----
+=== Syntax Checking
+
+If you use https://www.flycheck.org/[Flycheck], it ships a built-in
+`asciidoctor` checker that works in `adoc-mode` out of the box - it runs the
+`asciidoctor` command and reports its errors and warnings inline. Just enable
+`flycheck-mode` (and make sure `asciidoctor` is on your `PATH`):
+
+[source,emacs-lisp]
+----
+(add-hook 'adoc-mode-hook #'flycheck-mode)
+----
+
=== Image Preview
If you click kbd:[mouse-3] on an image link like
