summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordefanor <defanor@uberspace.net>2018-04-24 00:56:19 +0300
committerdefanor <defanor@uberspace.net>2018-04-24 00:56:19 +0300
commitc3c944ec936b1980abc0f8adc2615d4e458da8f3 (patch)
tree0a14a7fa0c979b3c615f5768e641583c8439f05b /README.md
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2e7e1c4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# html-wysiwyg-mode
+
+This is a minor mode for HTML editing, which can be used with
+`html-mode`:
+
+```elisp
+(require 'html-wysiwyg)
+(add-hook 'html-mode-hook 'html-wysiwyg-mode)
+```
+
+It hides links and allows to edit them via minibuffer, similarly to
+`org-mode`.
+
+![An example](https://defanor.uberspace.net/pictures/html-wysiwyg.png)
+
+It parses HTML with regexps, font lock's multiline handling is
+imperfect, and generally it is just a quick hack. But still better
+than reading through all the URIs.