branch: externals/valign
commit a9614dee2acc9bec40d0632a0a0503f61de0eb51
Author: Yuan Fu <[email protected]>
Commit: Yuan Fu <[email protected]>
Update documentation
* README.org: Add doc.
* valign.el (Commentary): Add doc.
---
README.org | 9 +++++++--
valign.el | 16 +++++++++++-----
2 files changed, 18 insertions(+), 7 deletions(-)
diff --git a/README.org b/README.org
index 668705b..fde2197 100644
--- a/README.org
+++ b/README.org
@@ -1,11 +1,16 @@
#+TITLE: Valign.el
-This package provides visual alignment for Org tables on GUI Emacs. It can
properly align tables containing variable-pitch font, CJK characters and
images. In the meantime, the text-based alignment generated by Org mode is left
untouched.
+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. In the meantime, the text-based alignment generated by
Org mode (or Markdown mode) is left untouched.
-To use this package, load it and run =M-x valign-mode RET=. And any Org tables
in Org mode should be automatically aligned. If you want to align a table
manually, run =M-x valign-table RET= on a Org table.
+To use this package, load it and run =M-x valign-mode RET=. And any Org tables
in Org mode should be automatically aligned. If you want to align a table
manually, run =M-x valign-table RET= on a table.
You can choose from the two styles by customizing ~valign-separator-row-style~.
[[./table-multi.png]]
[[./table-single.png]]
+Features not yet supported:
+ - Support org-ident. It uses line-prefix, and we don’t support it right now.
+ - Hided links in markdown still occupy the full length of the link, because
it uses character composition, which we don’t support now.
+
+If you are interested in adding support for them, look into
~valign--pixel-width-from-to~.
diff --git a/valign.el b/valign.el
index bd434dc..3beb3d6 100644
--- a/valign.el
+++ b/valign.el
@@ -10,18 +10,24 @@
;;; Commentary:
;;
-;; This package provides visual alignment for Org tables on GUI Emacs.
-;; It can properly align tables containing variable-pitch font, CJK
-;; characters and images. In the meantime, the text-based alignment
-;; generated by Org mode is left untouched.
+;; 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. In the meantime,
+;; the text-based alignment generated by Org mode (or Markdown mode)
+;; is left untouched.
;;
;; To use this package, load it and run M-x valign-mode RET. And any
;; Org tables in Org mode should be automatically aligned. If you want
-;; to align a table manually, run M-x valign-table RET on a Org table.
+;; to align a table manually, run M-x valign-table RET on a table.
;;
;; Valign provides two styles of separator, |-----|-----|, and
;; | |. Customize ‘valign-separator-row-style’ to set a
;; style.
+;;
+;; TODO
+;; - Support org-ident. It uses line-prefix, and we don’t support it.
+;; - Hided links in markdown still occupy the full length of the link,
+;; because it uses character composition, which we don’t support.
;;; Code:
;;
