branch: elpa/org-superstar
commit 4a4ae121c165494fb997f057affff4a4a7740faf
Author: D. Williams <[email protected]>
Commit: D. Williams <[email protected]>
Add further documentation regarding org-indent-mode.
---
org-superstar.el | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/org-superstar.el b/org-superstar.el
index a07a6ad0d4..bdda12d978 100644
--- a/org-superstar.el
+++ b/org-superstar.el
@@ -306,6 +306,15 @@ A more radical version of ‘org-hide-leading-stars’, where
the
indentation caused by leading stars is completely removed. It
works similar to ‘org-hide-emphasis-markers’.
+If Non-nil, this variable takes precedence over
+‘org-hide-leading-stars’ and
+‘org-hide-leading-stars-before-indent-mode’.
+
+This variable only eliminates indentation caused directly by
+leading stars, meaning additional indentation should be
+preserved. For an example of this, see the minor-mode command
+‘org-indent-mode’.
+
You should call ‘org-superstar-restart’ after changing this
variable for your changes to take effect."
:group 'org-superstar
