Add READMEs for several modules
This commit is contained in:
parent
cbabf6849c
commit
4ff80cf416
10 changed files with 160 additions and 16 deletions
17
modules/ui/doom-dashboard/README.org
Normal file
17
modules/ui/doom-dashboard/README.org
Normal file
|
@ -0,0 +1,17 @@
|
|||
#+TITLE: :ui doom-dashboard
|
||||
|
||||
This module gives Doom Emacs a dashboard buffer.
|
||||
|
||||
It is loosely inspired by Atom's dashboard.
|
||||
|
||||
* Table of Contents :TOC:
|
||||
- [[#install][Install]]
|
||||
- [[#keybindings][Keybindings]]
|
||||
- [[#customization][Customization]]
|
||||
|
||||
* Install
|
||||
This module only requires that ~all-the-icons~'s icon fonts are installed. Use ~M-x all-the-icons-install-fonts~ to do so.
|
||||
|
||||
* Keybindings
|
||||
|
||||
* Customization
|
7
modules/ui/doom-quit/README.org
Normal file
7
modules/ui/doom-quit/README.org
Normal file
|
@ -0,0 +1,7 @@
|
|||
#+TITLE: :ui doom-quit
|
||||
|
||||
Remember these?
|
||||
|
||||
[[http://cf.geekdo-images.com/images/pic969210_md.jpg]]
|
||||
|
||||
Yeah.
|
13
modules/ui/hl-todo/README.org
Normal file
13
modules/ui/hl-todo/README.org
Normal file
|
@ -0,0 +1,13 @@
|
|||
#+TITLE: :ui hl-todo
|
||||
|
||||
This module adds syntax highlighting for TODO/FIXME/NOTE tags in programming major-modes.
|
||||
|
||||
What keywords are highlighted (and their color) can be customized through ~hl-todo-keyword-faces~.
|
||||
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
;; the default
|
||||
(setq hl-todo-keyword-faces
|
||||
`(("TODO" . ,(face-foreground 'warning))
|
||||
("FIXME" . ,(face-foreground 'error))
|
||||
("NOTE" . ,(face-foreground 'success))))
|
||||
#+END_SRC
|
5
modules/ui/tabbar/README.org
Normal file
5
modules/ui/tabbar/README.org
Normal file
|
@ -0,0 +1,5 @@
|
|||
#+TITLE: :ui tabbar
|
||||
|
||||
This module adds a tabbar to the Emacs UI.
|
||||
|
||||
I don't recommend you use this module. It is here for reference, is unstable and doesn't integrate with Doom's UI well. I find ivy, helm or even ~buffer-menu~ to be better suited for buffer management.
|
10
modules/ui/unicode/README.org
Normal file
10
modules/ui/unicode/README.org
Normal file
|
@ -0,0 +1,10 @@
|
|||
#+TITLE: :ui unicode
|
||||
|
||||
This unicode extends Doom's ability to display non-English unicode.
|
||||
|
||||
This is for non-English Emacs users, for whom Doom's built-in unicode support in insufficient.
|
||||
|
||||
When this module is enabled...
|
||||
|
||||
+ The first time you run Emacs a unicode cache will be generated -- this will take a while!
|
||||
+ Doom will ignore the ~doom-unicode-font~ variable and the ~:unicode-font~ setting.
|
Loading…
Add table
Add a link
Reference in a new issue