branch: externals/org-modern
commit bf318d53b06cd21250dbb3d8f0a330fcd4025527
Author: JD Smith <[email protected]>
Commit: JD Smith <[email protected]>
Updated README's to mention org-modern-indent
---
CHANGELOG.org | 4 +++-
README-indent.md | 39 ++++++---------------------------------
README.org | 33 ++++++++++++++++++++++++++++++---
3 files changed, 39 insertions(+), 37 deletions(-)
diff --git a/CHANGELOG.org b/CHANGELOG.org
index 59f4d9acf3..3cf6b87f3e 100644
--- a/CHANGELOG.org
+++ b/CHANGELOG.org
@@ -1,9 +1,11 @@
#+title: org-modern.el - Changelog
-#+author: Daniel Mendler
+#+author: Daniel Mendler & J.D. Smith
#+language: en
* Development
+- Merged [[https://github.com/jdtsmith/org-modern-indent][org-modern-indent]]
as a new extension.
+- Automatically provide code block bracket styling when ~org-indent~ is
enabled using ~org-modern-indent-mode~.
- Add ~org-modern-habit~ face to improve habit progress fontification.
* Version 1.7 (2025-03-11)
diff --git a/README-indent.md b/README-indent.md
index 42d595002d..1dad3e5cc6 100644
--- a/README-indent.md
+++ b/README-indent.md
@@ -4,12 +4,15 @@ Modern block styling with `org-indent`.
[`org-modern`](https://github.com/minad/org-modern) provides a clean and
efficient org style. The blocks (e.g. source, example) are particularly nicely
decorated. But when `org-indent` is enabled, the block "bracket", which uses
the fringe area, is disabled.
-This small package approximately reproduces the block styling of `org-modern`
when using `org-indent`. It can be used with or without `org-modern`. Recent
versions support "bulk-indented" blocks nested within lists:
+This small package reproduces the block styling of `org-modern` when using
`org-indent`. Recent versions support "bulk-indented" blocks nested within
lists:
<img width="716" alt="image"
src="https://github.com/user-attachments/assets/7ca42ce7-dcfb-4c66-b5f4-1798a4fd4df5";
/>
+>[!NOTE]
+> Non-nil `line-spacing` is not recommended with this extension, as it leads
to gap in the vertical bars drawn alongside blocks.
## Updates
+- **v0.6**: Merged as an `org-modern` extension.
- **v0.5.1**: Small simplifications for block drawing.
- **v0.5**: Another complete rewrite which substantially improves
performance and accuracy. Now block detection uses `org-element`
@@ -34,17 +37,6 @@ This small package approximately reproduces the block
styling of `org-modern` wh
3. Enables in-text bracket decorations for "bulk-indented" blocks, for
example blocks situated
in an arbitrarily-nested plain list item.
-## Configure
-
-```elisp
-(use-package org-modern-indent
- :load-path "~/code/emacs/org-modern-indent/"
- ; or
- ; :straight (org-modern-indent :type git :host github :repo
"jdtsmith/org-modern-indent"))
- :config ; add late to hook
- (add-hook 'org-mode-hook #'org-modern-indent-mode 90))
-```
-
>[!IMPORTANT]
> `org-modern-indent` uses `org-indent`, and expects it to be enabled to
> achieve its formatting. To activate `org-indent-mode` by default in all org
> files, set `org-startup-indented=t`.
@@ -88,26 +80,9 @@ The default `fixed-pitch` font (from which `org-meta-line`
inherits) has line sp
If you'd like a different face than `org-meta-line` for the "bracket",
configure the `org-modern-indent-bracket-line` face.
-### Related config
+### Related configuration
-Optionally, if you want to use
[org-modern](https://github.com/minad/org-modern) too (I do), a suggested
config:
-
-```elisp
-(use-package org-modern
- :ensure t
- :custom
- (org-modern-hide-stars nil) ; adds extra indentation
- (org-modern-table nil)
- (org-modern-list
- '(;; (?- . "-")
- (?* . "•")
- (?+ . "‣")))
- :hook
- (org-mode . org-modern-mode)
- (org-agenda-finalize . org-modern-agenda))
-```
-
-Also optional; use org-bullets instead for nicely aligned bullet stars.
+Optional; use org-bullets instead for nicely aligned bullet stars.
```elisp
(use-package org-bullets-mode
@@ -116,9 +91,7 @@ Also optional; use org-bullets instead for nicely aligned
bullet stars.
:hook org-mode)
```
-
## Related packages
-- [`org-modern`](https://github.com/minad/org-modern): A modern org styling.
Works best without org-indent.
- [`org-bullets`](https://github.com/sabof/org-bullets): Unicode heading
bullet replacement.
- [`org-superstar`](https://github.com/integral-dw/org-superstar-mode):
Prettify headings and plain lists.
diff --git a/README.org b/README.org
index 1409c4983c..c3496a0485 100644
--- a/README.org
+++ b/README.org
@@ -22,7 +22,9 @@ 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-mode=
turned on and off. The
-elegant theme featured in the screenshot is
[[https://protesilaos.com/emacs/modus-themes][modus-operandi]].
+elegant theme featured in the screenshot is
[[https://protesilaos.com/emacs/modus-themes][modus-operandi]]. Since version
2.0,
+this package incorporates ~org-modern-indent~; see [[./README-INDENT.md][its
README]] for more information
+and a screenshot.
Since this package adjusts text styling, it depends on your font settings. You
should ensure that your =variable-pitch= and =fixed-pitch= fonts combine
@@ -93,10 +95,35 @@ screenshot above after the installation of =org-modern=.
(global-org-modern-mode)
#+end_src
+An alternative setup, using ~use-package~:
+
+#+begin_src emacs-lisp
+ (use-package org-modern
+ :custom
+ (org-modern-hide-stars nil)
+ (org-modern-todo-faces
+ '(("STARTED" :foreground "yellow")
+ ("CANCELED" org-special-keyword :inverse-video t :weight bold)))
+ (org-modern-list
+ '((?* . "•")
+ (?+ . "‣")))
+ (org-modern-fold-stars
+ '(("▶" . "▼")
+ ("▷" . "▽")
+ ("▸" . "▾")
+ ("▹" . "▿")))
+ (org-modern-checkbox
+ '((?X . "✔")
+ (?- . "┅")
+ (?\s . " ")))
+ (org-modern-label-border 1)
+ :hook
+ (org-mode . org-modern-mode)
+ (org-agenda-finalize . org-modern-agenda))
+#+end_src
+
* Incompatibilities
-- =org-indent-mode= is not compatible with the block prettification in the
fringe.
- If =org-indent-mode= is enabled, =org-modern= will disable the block
prettification.
- =org-num-mode= interferes with the =org-modern= prettification of TODO
keywords.
- =visual-wrap-prefix-mode= relies on the =wrap-prefix= text property which is
also
used by =org-modern=.
