History

Henrik Lissner e77a45bc22 docs: use lowercase keywords As per Org's new defaults, which we're adopting elsewhere, so may as well adopt it here.		2022-08-02 16:23:43 +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: :app :checkers :config :emacs :term :tools :ui	2021-09-15 17:47:17 +02:00
README.org	docs: use lowercase keywords	2022-08-02 16:23:43 +02:00

README.org

:ui treemacs

Description
- Maintainers
- Module flags
- Packages
- Hacks
- Changelog
Installation
Usage
Configuration
Troubleshooting
Frequently asked questions
Appendix

← Back to module index ! Issues ↖ Github ± Suggest edits ? Help

Description unfold

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

Maintainers

@hlissner

Become a maintainer?

Module flags

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

Packages

lsp-treemacs if +lsp
treemacs
treemacs-evil if :editor evil +everywhere
treemacs-magit if :tools magit
treemacs-persp if :ui workspaces
treemacs-projectile

Hacks

No hacks documented for this module.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

If python3 is present on your $PATH, treemacs will use it to display git status for files.

TODO Usage

🔨 This module's usage documentation is incomplete. Complete it?

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

TODO Configuration

🔨 This module's configuration documentation is incomplete. Complete it?

The variable +treemacs-git-mode sets the type of git integration that treemacs has.

There are 3 possible values:

'simple (the default), 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.

🚧 +treemacs-git-mode must be set before treemacs is loaded.

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

🔨 This module has no appendix yet. Write one?