[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/nano-modeline d18fa48999 08/26: Update documentation
From: |
ELPA Syncer |
Subject: |
[elpa] externals/nano-modeline d18fa48999 08/26: Update documentation |
Date: |
Fri, 2 Jun 2023 03:59:07 -0400 (EDT) |
branch: externals/nano-modeline
commit d18fa489995f6d2d8e612945a87f1e59e6497d17
Author: Nicolas P. Rougier <Nicolas.Rougier@inria.fr>
Commit: Nicolas P. Rougier <Nicolas.Rougier@inria.fr>
Update documentation
---
README.md | 31 +++++++++++++++----------------
nano-modeline.el | 17 +++++++++++++++--
2 files changed, 30 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
index 015d6f4e8f..04b6daae79 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,12 @@
Nano modeline is a an alterntive to the GNU/Emacs modeline. It can be
displayed at the bottom (mode-line) or at the top (header-line)
-depending on nano-modeline-position custom setting.
+depending on nano-modeline-position custom setting. There are several
+modelines that can be installed on a per-mode basis or be made the
+default one. Currently, only the prog and text mode are generic enough
+to be made the default.
+
+You can also design your own modeline using the various elements composing a
modeline. See sources for several example.
### Installation
@@ -26,24 +31,18 @@ Install with `M-: (package-install 'nano-modeline)`
(add-hook 'org-agenda-mode-hook #'nano-modeline-org-agenda-mode)
```
+To make a specific mode the default one, you can type:
+
+```emacs-lisp
+(nano-modeline-text-mode t)
+```
+
+Currently, only the prog and text mode are generic enough to be made the
+default.
+
### Screenshots (using [N Λ N O theme](https://github.com/rougier/nano-theme)):
![](images/nano-modeline.png)
-![](images/nano-modeline-light.png)
-![](images/nano-modeline-dark.png)
-
-![](images/nano-modeline-RW-focused.png)
-![](images/nano-modeline-RW-unfocused.png)
-![](images/nano-modeline-RO-focused.png)
-![](images/nano-modeline-RO-unfocused.png)
-![](images/nano-modeline-MD-focused.png)
-![](images/nano-modeline-MD-unfocused.png)
-![](images/nano-modeline-mail.png)
-![](images/nano-modeline-term.png)
-![](images/nano-modeline-elfeed.png)
-![](images/nano-modeline-deft.png)
-![](images/nano-modeline-docview.png)
-![](images/nano-modeline-agenda.png)
diff --git a/nano-modeline.el b/nano-modeline.el
index 262dd898b4..e0c34d6e0d 100644
--- a/nano-modeline.el
+++ b/nano-modeline.el
@@ -24,10 +24,21 @@
;; see <https://www.gnu.org/licenses/>.
;;; Commentary:
-;;
+;;
+;; Nano modeline is a an alterntive to the GNU/Emacs modeline. It can
+;; be displayed at the bottom (mode-line) or at the top (header-line)
+;; depending on the nano-modeline-position custom setting. There are
+;; several modelines that can be installed on a per-mode basis or as
+;; the default one.
;;
;; Usage example:
;;
+;; Install prog mode modeline:
+;; (add-hook 'prog-mode-hook #'nano-modeline-prog-mode)
+;;
+;; Make text mode modeline the default:
+;; (nano-modeline-text-mode t)
+;;
;;
;;; NEWS:
;;
@@ -133,7 +144,9 @@
,(when (facep 'nano-popout-i) 'nano-popout-i)))
(bold-active . (bold))
(faded-active . (,(when (facep 'nano-faded) 'nano-faded))))
- "Nano line faces"
+ "Nano line faces.
+
+Each face defined here is used by the modeline depending on the current state
(active / inactive). It is ok to define a face for a single state. In such
case, the alternative state will use defaults."
:type '(alist :key-type (symbol :tag "Face")
:value-type (repeat :tag "inherits" face)))
- [elpa] externals/nano-modeline updated (b8795c14ad -> bead6850a1), ELPA Syncer, 2023/06/02
- [elpa] externals/nano-modeline 21263a0b3d 01/26: Complete rewrite, ELPA Syncer, 2023/06/02
- [elpa] externals/nano-modeline 7f8c45c5fb 02/26: Some modelines can be made default (text or prog), ELPA Syncer, 2023/06/02
- [elpa] externals/nano-modeline d18fa48999 08/26: Update documentation,
ELPA Syncer <=
- [elpa] externals/nano-modeline 3e29afaea2 09/26: Better alignment with fringes and margins, ELPA Syncer, 2023/06/02
- [elpa] externals/nano-modeline 7663311747 04/26: Bugfix with deadline date, ELPA Syncer, 2023/06/02
- [elpa] externals/nano-modeline 26470be833 07/26: Nil face is ok, ELPA Syncer, 2023/06/02
- [elpa] externals/nano-modeline 7503853c0b 13/26: Added clickalt text/svg buttons, ELPA Syncer, 2023/06/02
- [elpa] externals/nano-modeline 961065fe66 16/26: Added possibility to have icon in buttons, ELPA Syncer, 2023/06/02
- [elpa] externals/nano-modeline a2bf4fd073 22/26: Several group of butons are now possible, ELPA Syncer, 2023/06/02
- [elpa] externals/nano-modeline bead6850a1 26/26: Add usage example to documentation, ELPA Syncer, 2023/06/02
- [elpa] externals/nano-modeline 0b47e73d04 18/26: Added possibility for dynamic buttons, ELPA Syncer, 2023/06/02
- [elpa] externals/nano-modeline 7331307df8 03/26: Upated documentation to new implementation, ELPA Syncer, 2023/06/02
- [elpa] externals/nano-modeline 239000d7e1 10/26: Handle case when fringes are outside margins, ELPA Syncer, 2023/06/02