Add READMEs for several modules
This commit is contained in:
parent
cbabf6849c
commit
4ff80cf416
10 changed files with 160 additions and 16 deletions
|
@ -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 |
|
Loading…
Add table
Add a link
Reference in a new issue