mirror of
https://github.com/doomemacs/doomemacs.git
synced 2025-12-07 19:10:28 -08:00
ui/treemacs
Description
Treemacs is a file and project explorer similar to NeoTree or vim’s NerdTree, but largely inspired by the Project Explorer in Eclipse. It shows the file system outlines of your projects in a simple tree layout allowing quick navigation and exploration, while also possessing basic file management utilities. It includes:
- Integration with Git (when
:tools magitis enabled) - Integration with Evil (when
:editor evil +everywhereis enabled) - Workspace awareness (when
:ui workspacesis enabled)
Maintainers
- This module has no dedicated maintainers.
Module Flags
+lspEnablelsp-treemacsintegration and add shortcuts for common commands.
Plugins
- treemacs
- treemacs-projectile
-
:editor evil +everywhere -
:tools magit -
:ui workspaces -
+lsp
Prerequisites
If +treemacs-git-mode is set to extended or deferred you will need to have
python3 installed.
Features
The project bar can be opened using SPC o p.
| Keybind | Description |
|---|---|
o s |
Open a horizontal dired buffer on the currently highlighted node |
o v |
Open a vertical dired buffer on the currently highlighted node |
Configuration
The variable +treemacs-git-mode sets the type of git integration that treemacs
has.
There are 3 possible values:
- simple, which highlights only files based on their git status, and is slightly faster,
- extended, which highlights both files and directories, but requires python,
- deferred, same as extended, but highlights asynchronously.
the default being simple
This must be set before treemacs has loaded.