branch: externals/org-modern
commit 074b7e5b514a0d7758bc0afce3d107ddc40c5da2
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
README updates
---
README.org | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/README.org b/README.org
index 7f927aa32d..49a051b377 100644
--- a/README.org
+++ b/README.org
@@ -13,16 +13,20 @@ of each syntax element individually via the =org-modern=
customization group.
[[https://github.com/minad/org-modern/blob/screenshots/example.gif?raw=true]]
-The screenshots shows [[file:example.org][example.org]] with =org-modern=
turned on and off. The
+The screenshots shows [[file:example.org][example.org]] with =org-modern-mode=
turned on and off. The
elegant theme featured in the screenshot is
[[https://protesilaos.com/emacs/modus-themes][modus-operandi]].
This package is still early in its development, so expect bugs and issues in
particular due to unfortunate interactions of the =variable-pitch= and
=fixed-pitch=
fonts. You should ensure that your fonts combine harmonically and have
-approximately the same height. Note that =org-indent-mode= interferes with
some of
-the style elements applied by =org-modern-mode=, e.g., the block brackets in
the
-fringe. Bug reports, improvement or style proposals are welcome! Maybe some
more
-Org elements deserve styling or alternative stylings should be offered?
+approximately the same height. =org-modern-mode= tries to adjust the tag label
+display based on the value of =line-spacing=. This looks best if
=line-spacing= has
+a value between 0.1 and 0.4 in the Org buffer. Note that =org-indent-mode=
+interferes with some of the style elements applied by =org-modern-mode=, e.g.,
the
+block brackets in the fringe.
+
+Bug reports, improvement or style proposals are welcome! Maybe some more Org
+elements deserve styling or alternative stylings should be offered?
The tag style of =org-modern= is a poor Emacsien's ripoff from Nicholas
Rougier's
beautiful [[https://github.com/rougier/svg-tag-mode][svg-tag-mode]]. In
contrast to =svg-tag-mode=, this package avoids images
@@ -31,8 +35,8 @@ text properties, the styled text, e.g., dates or tags stay
editable and are easy
to interact with.
On the downside, this restricts our flexibility and may lead to font-dependent
-issues. We do our best, but for example there is no way we can round corners.
Of
-course a combination of =org-modern= with =svg-tag-mode= is possible. You can
use
+issues. We do our best, but for example there is no way we can get round
+corners. Combining =org-modern-mode= with =svg-tag-mode= is possible. You can
use
SVG tags and use the table and block styling from =org-modern=. If you are
interested in further tweaks, Emacs comes with the builtin
=prettify-symbols-mode=
which can be used for individual styling of custom keywords.
@@ -50,7 +54,3 @@ manually in an Org buffer by invoking =M-x org-modern-mode=.
In order to enable
#+begin_src emacs-lisp
(add-hook 'org-mode-hook #'org-modern-mode)
#+end_src
-
-Note that =org-modern-mode= tries to adjust the tag label display based on the
-value of =line-spacing=. This looks best if =line-spacing= has a value between
0.1
-and 0.4 in the Org buffer.
