open:doom-emacs [EL]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
# Doom Emacs


  - https://github.com/hlissner/doom-emacs
  - [Module Index](https://github.com/hlissner/doom-emacs/blob/develop/docs/modules.org)


## Files

  - [[init.el]]
  - [[config.el]]
  - [[packages.el]]

## Library

  - [[Projectile]]
  - [[treemacs]]
  - [[evil-mode]]

## Install

- https://github.com/hlissner/doom-emacs/blob/develop/docs/getting_started.org#on-macos

### Doom Depedencies

<code>
# required dependencies
brew install git ripgrep
# optional dependencies
brew install coreutils fd
# Installs clang
xcode-select --install
</code>

### emacs-mac

<code>
brew tap railwaycat/emacsmacport
brew install emacs-mac --with-modules
ln -s /usr/local/opt/emacs-mac/Emacs.app /Applications/Emacs.app
</code>

### Install

<code>
git clone --depth 1 https://github.com/hlissner/doom-emacs ~/.emacs.d
~/.emacs.d/bin/doom install
</code>

## doom utility

### doom doctor

<code error>
! Couldn't find a markdown compiler, `markdown-preview' won't work
! Couldn't find shellcheck. Shell script linting will not work
! The installed grep binary was not built with support for PCRE lookaheads.
</code>

<code>
npm install -g marked
brew install shellcheck
brew install pcre
</code>


  - [[doom sync]]: This synchronizes your config with Doom Emacs. It ensures that needed packages are installed, orphaned packages are removed and necessary metadata correctly generated. Run this whenever you modify your doom! block or packages.el file. You’ll need doom sync -u if you override the recipe of package installed by another module.
  - [[doom upgrade]]: Updates Doom Emacs (if available) and all its packages.
  - [[doom env]]: (Re)generates an “envvar file”, which is a snapshot of your shell environment that Doom loads at startup. If your app launcher or OS launches Emacs in the wrong environment you will need this. **This is required for GUI Emacs users on MacOS.**
  - [[doom doctor]]: If Doom misbehaves, the doc will diagnose common issues with your installation, system and environment.
  - [[doom purge]]: Over time, the repositories for Doom’s plugins will accumulate. Run this command from time to time to delete old, orphaned packages, and with the -g switch to compact existing package repos.

## Doom Key

  - [[Doom SPC]]

## Links

  - https://github.com/hlissner/doom-emacs/blob/develop/docs/index.org#tutorials--guides
  - https://zzamboni.org/post/my-doom-emacs-configuration-with-commentary
  - https://tecosaur.github.io/emacs-config/config.html
  - https://github.com/tecosaur/emacs-config
  - https://github.com/shiren/dotfiles
  - https://noelwelsh.com/posts/doom-emacs/
  - https://gitlab.com/justinekizhak/dotfiles/-/tree/master/emacs/doom.d
  - https://medium.com/urbint-engineering/emacs-doom-for-newbies-1f8038604e3b