Add READMEs for several modules
This commit is contained in:
parent
cbabf6849c
commit
4ff80cf416
10 changed files with 160 additions and 16 deletions
27
modules/feature/snippets/README.org
Normal file
27
modules/feature/snippets/README.org
Normal file
|
@ -0,0 +1,27 @@
|
||||||
|
#+TITLE: :feature snippets
|
||||||
|
|
||||||
|
This module adds snippets to Emacs, powered by yasnippet.
|
||||||
|
|
||||||
|
* Table of Contents :TOC:
|
||||||
|
- [[#install][Install]]
|
||||||
|
|
||||||
|
* Install
|
||||||
|
There are no extra dependencies for this module.
|
||||||
|
|
||||||
|
By default, this module uses the snippet library included with yasnippet.
|
||||||
|
|
||||||
|
For the best experience, I'd suggest installing mine from https://github.com/hlissner/emacs-snippets -- they have been tailored specifically for Doom.
|
||||||
|
|
||||||
|
1. Clone the repo to your private module:
|
||||||
|
#+BEGIN_SRC bash
|
||||||
|
git clone https://github.com/hlissner/emacs-snippets ~/.emacs.d/modules/private/$(whoami)/snippets
|
||||||
|
#+END_SRC
|
||||||
|
2. Tell yasnippet where to look for them:
|
||||||
|
#+BEGIN_SRC emacs-lisp
|
||||||
|
;; modules/private/{USERNAME}/config.el
|
||||||
|
(after! yasnippet
|
||||||
|
(setq yas-snippet-dirs
|
||||||
|
(append (list (expand-file-name "snippets/" (file-name-directory load-file-name)))
|
||||||
|
(delq 'yas-installed-snippets-dir yas-snippet-dirs))))
|
||||||
|
#+END_SRC
|
||||||
|
|
|
@ -1,16 +0,0 @@
|
||||||
# javascript
|
|
||||||
|
|
||||||
Javascript support, including auto-completion (tern), REPL support
|
|
||||||
(nodejs-repl), refactoring commands (js2-refactor), and syntax checking
|
|
||||||
(flycheck).
|
|
||||||
|
|
||||||
Includes coffescript and jsx support, as well as project minor modes for nodejs
|
|
||||||
projects (with a package.json) or launchbar 6 actions.
|
|
||||||
|
|
||||||
## External Dependencies
|
|
||||||
|
|
||||||
Run `make bootstrap js` to install these.
|
|
||||||
|
|
||||||
+ NodeJS & NPM (`brew install node`, `pacman -S nodejs npm`)
|
|
||||||
+ tern: `npm -g install tern` (for completion)
|
|
||||||
|
|
46
modules/lang/javascript/README.org
Normal file
46
modules/lang/javascript/README.org
Normal file
|
@ -0,0 +1,46 @@
|
||||||
|
#+TITLE: :lang javascript
|
||||||
|
|
||||||
|
This module adds Javascript support.
|
||||||
|
|
||||||
|
+ Code completion (tern)
|
||||||
|
+ REPL support (nodejs-repl)
|
||||||
|
+ Refactoring commands (js2-refactor)
|
||||||
|
+ Syntax checking (flycheck)
|
||||||
|
+ Browser code injection with skewer-mode
|
||||||
|
+ Coffeescript & JSX support
|
||||||
|
+ Jump-to-definitions and references support (xref)
|
||||||
|
|
||||||
|
* Table of Contents :TOC:
|
||||||
|
- [[#install][Install]]
|
||||||
|
- [[#node--npm][Node & NPM]]
|
||||||
|
- [[#dependencies][Dependencies]]
|
||||||
|
- [[#appendix][Appendix]]
|
||||||
|
- [[#commands][Commands]]
|
||||||
|
|
||||||
|
* Install
|
||||||
|
** Node & NPM
|
||||||
|
To get started with Javascript, you'll need node and its package manager, NPM, installed.
|
||||||
|
|
||||||
|
*** MacOS
|
||||||
|
#+BEGIN_SRC sh :tangle (if (doom-system-os 'macos) "yes")
|
||||||
|
brew install node
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
*** Arch Linux
|
||||||
|
#+BEGIN_SRC sh :dir /sudo:: :tangle (if (doom-system-os 'arch) "yes")
|
||||||
|
sudo pacman --needed --noconfirm -S nodejs npm
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
** Dependencies
|
||||||
|
This module optionally requires ~tern~ for code completion.
|
||||||
|
|
||||||
|
#+BEGIN_SRC sh
|
||||||
|
npm -g install tern
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
* Appendix
|
||||||
|
** Commands
|
||||||
|
| command | key / ex command | description |
|
||||||
|
|----------------------------------+------------------+------------------------------------------------------------|
|
||||||
|
| ~+javascript/repl~ | =:repl= | Open the NodeJS REPL (or send the current selection to it) |
|
||||||
|
| ~+javascript/skewer-this-buffer~ | =SPC m S= | Attaches a browser to the current buffer |
|
13
modules/lang/perl/README.org
Normal file
13
modules/lang/perl/README.org
Normal file
|
@ -0,0 +1,13 @@
|
||||||
|
#+TITLE: :lang perl
|
||||||
|
|
||||||
|
This module adds support for Perl 6, and flycheck support for all versions of Perl.
|
||||||
|
|
||||||
|
* Table of Contents :TOC:
|
||||||
|
- [[#install][Install]]
|
||||||
|
|
||||||
|
* Install
|
||||||
|
This module depends on perl itself. Perl <5 typically comes bundled with most OSes and Linux distros.
|
||||||
|
|
||||||
|
You'll have to install
|
||||||
|
|
||||||
|
There are no other dependencies.
|
22
modules/lang/sh/README.org
Normal file
22
modules/lang/sh/README.org
Normal file
|
@ -0,0 +1,22 @@
|
||||||
|
#+TITLE: :lang sh
|
||||||
|
|
||||||
|
This module adds support for shell scripting languages.
|
||||||
|
|
||||||
|
+ Code completion (company-shell)
|
||||||
|
+ Syntax Checking (flycheck)
|
||||||
|
+ Added command substitution and variable interpolation fontification
|
||||||
|
+ REPL support
|
||||||
|
|
||||||
|
* Table of Contents :TOC:
|
||||||
|
- [[#install][Install]]
|
||||||
|
- [[#appendix][Appendix]]
|
||||||
|
- [[#commands][Commands]]
|
||||||
|
|
||||||
|
* Install
|
||||||
|
This module has no dependencies.
|
||||||
|
|
||||||
|
* Appendix
|
||||||
|
** Commands
|
||||||
|
| command | key / ex command | description |
|
||||||
|
|------------+------------------+-------------------------------------------------------|
|
||||||
|
| ~+sh/repl~ | =:repl= | Open a terminal (or send the current selection to it) |
|
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