emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/ui/treemacs
History
Henrik Lissner d212f3bd13
bump: :ui 
Alexander-Miller/treemacs@1820db42c6 -> Alexander-Miller/treemacs@b18a05b1f6
Bad-ptr/persp-mode.el@298df111f0 -> Bad-ptr/persp-mode.el@7a594a3d8f
abo-abo/ace-window@c7cb315c14 -> abo-abo/ace-window@0577c426a9
abo-abo/hydra@2d553787ac -> abo-abo/hydra@9e9e00cb24
doomemacs/themes@56e8a93b2d -> doomemacs/themes@83fd9545c2
edkolev/evil-goggles@08a22058fd -> edkolev/evil-goggles@8f20a16e74
ema2159/centaur-tabs@5860a5c40c -> ema2159/centaur-tabs@f4cef95acb
emacs-lsp/lsp-treemacs@c40a381730 -> emacs-lsp/lsp-treemacs@355e468b7f
seagle0128/doom-modeline@84573ae5e7 -> seagle0128/doom-modeline@ce9899f00a
tarsius/hl-todo@42f744ffb5 -> tarsius/hl-todo@e52285965b

Close: #6228
2022-03-31 21:08:31 +02:00
..
autoload.el Fix void-function treemacs-current-visibility 2020-05-03 16:31:06 -04:00
config.el fix(treemacs): remove defunct ace-window advice 2021-09-24 23:41:42 +02:00
doctor.el Fix treemacs + lsp doctor check 2021-04-18 21:17:52 -07:00
packages.el bump: :ui 2022-03-31 21:08:31 +02:00
README.org doc: adding treemacs readme (#4797) 2021-05-24 13:47:20 -04:00

README.org

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 magit is enabled)
  • Integration with Evil (when :editor evil +everywhere is enabled)
  • Workspace awareness (when :ui workspaces is enabled)

Maintainers

  • This module has no dedicated maintainers.

Module Flags

  • +lsp Enable lsp-treemacs integration and add shortcuts for common commands.

Plugins

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:

  1. simple, which highlights only files based on their git status, and is slightly faster,
  2. extended, which highlights both files and directories, but requires python,
  3. deferred, same as extended, but highlights asynchronously.

the default being simple

This must be set before treemacs has loaded.

TODO Troubleshooting