branch: externals/org-modern
commit bc5819f450eae4dbf5937e424b2242a053d59a6d
Author: JD Smith <[email protected]>
Commit: JD Smith <[email protected]>
Add readme info
---
README.md | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/README.md b/README.md
index 3559dde9bd..712f741c47 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,14 @@
# org-modern-indent
org-modern and org-indent, working together
+
+[org-modern](https://github.com/minad/org-modern) provides a clean and
efficient org style. The blocks (e.g. source, example) are particularly nice.
But when `org-indent` is enabled, the block "bracket", based on the fringe, no
longer functions. This small package reproduces the block styling, even with
`org-indent`.
+
+## Configure
+
+Be sure to enable `org-indent` (see `org-startup-indented`).
+
+```elisp
+(use-package org-modern-indent
+ :hook
+ (org-modern-mode . org-modern-indent-mode))
+```
