branch: externals/valign
commit 16cbfe1181401fdd7fa8efbe02c7512eb83baefa
Author: Yuan Fu <[email protected]>
Commit: Yuan Fu <[email protected]>
* README.org: Add use-package snippet.
---
README.org | 20 +++++++++++++++-----
1 file changed, 15 insertions(+), 5 deletions(-)
diff --git a/README.org b/README.org
index f61a279..78c2209 100644
--- a/README.org
+++ b/README.org
@@ -2,19 +2,29 @@
This package provides visual alignment for Org and Markdown tables on GUI
Emacs. It can properly align tables containing variable-pitch font, CJK
characters and images. Meanwhile, the text-based alignment generated by Org
mode (or Markdown mode) is left untouched.
-
To use this package, load it and add ~valign-mode~ to ~org-mode-hook~ or
~markdown-mode-hook~:
#+begin_src emacs-lisp
-(add-hook ’org-mode-hook #’valign-mode)
+(add-hook 'org-mode-hook #'valign-mode)
#+end_src
[[./default.png]]
-Know problems:
+*Know problems:*
- Customizing ~org-table~ face seems to mess up the separator (it will
disappear).
- ~org-indent~ breaks the alignment. It uses line-prefix, and we don’t support
it right now.
-- Hidden links in markdown still occupy the full length of the link, because
it uses character composition, which we don’t support now.
-- Editing large tables (≥100 lines) is a bit laggy.
+- Hidden links in markdown still occupy the full length of the link, because
it uses character composition which we don’t support now.
+- Rendering large tables (≥100 lines) is laggy.
+
+* If you have ~use-package~ and ~quelpa~
+
+Firmin Martin kindly provided this snippet:
+#+begin_src emacs-lisp
+(use-package valign
+ :quelpa (valign :fetcher github :repo "casouri/valign")
+ :ensure t
+ :config
+ (add-hook 'org-mode-hook #'valign-mode))
+#+end_src
* Customization
Set ~valign-fancy-bar~ to ~non-nil~:
