Org Superstar

about | blog | config | notes | github

1. What is it?

org-superstar-mode is a simple package that aims to prettify Org-mode headings and lists by using UTF-8 characters for the faces.

2. Configuration

2.1. Setup Org-mode

First we should make sure that Org-mode is loaded up first.

(require 'init-org)

2.2. Package Install

Now we can configure org-superstar-mode.

(use-package org-superstar
  :after org
  :hook (org-mode . org-superstar-mode))

2.3. Hide Leading Bullets

We should make the leading stars here, truly invisible.

(setq org-hide-leading-stars nil)
(setq org-superstar-leading-bullet ?\s)
(setq org-superstar-leading-fallback ?\s)
(setq org-indent-mode-turns-on-hiding-stars nil)
(setq org-superstar-remove-leading-stars t)

2.4. Custom Bullet Faces

Let's also define our own custom bullets.

;; (setq org-superstar-headline-bullets-list '("◉" "●" "○" "▷"))
;; (setq org-superstar-headline-bullets-list '("•"))
(setq org-superstar-headline-bullets-list '("*"))
(setq org-superstar-cycle-headline-bullets nil)

The sizes of the bullets with the existing font is a little too much, let's reduce it a bit.

;; (with-eval-after-load 'org-superstar
;;   (set-face-attribute 'org-superstar-item nil :height 0.5)
;;   (set-face-attribute 'org-superstar-header-bullet nil :height 0.5)
;;   (set-face-attribute 'org-superstar-leading nil :height 0.5))

2.5. Feature Provide

(provide 'init-org-superstar-mode)

Created: 2021-11-13

Emacs 26.1 (Org mode 9.5)