History

Henrik Lissner 7f3412e317 bump: :ui Alexander-Miller/treemacs@54ef590b76 -> Alexander-Miller/treemacs@202d7f01d6 Bad-ptr/persp-mode.el@345baaa520 -> Bad-ptr/persp-mode.el@40e9993a97 dgutov/diff-hl@57d9d4e3e1 -> dgutov/diff-hl@b80ff9b4a7 ema2159/centaur-tabs@d6009c295a -> ema2159/centaur-tabs@063534bd00 emacs-lsp/lsp-treemacs@1d43e9e030 -> emacs-lsp/lsp-treemacs@fb1a07ae0a emacs-straight/minimap@4898d27768 -> emacs-straight/minimap@5aa0df40bc seagle0128/doom-modeline@1505c13564 -> seagle0128/doom-modeline@9920ef5116 tarsius/hl-todo@dd46d426c0 -> tarsius/hl-todo@82eba6b8f7		2024-08-08 17:26:58 -04:00
..
autoload.el	fix(treemacs): open last treemacs session if in $HOME or non-project	2024-07-16 11:23:11 -04:00
config.el	nit: minor comment reformatting & revision	2024-03-26 10:39:24 -04:00
doctor.el	refactor: deprecate featurep! for modulep!	2022-08-14 20:43:35 +02:00
packages.el	bump: :ui	2024-08-08 17:26:58 -04:00
README.org	docs(evil,latex,vterm,treemacs): correct notices	2023-09-17 03:27:49 +02:00

README.org

:ui treemacs

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

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

Maintainers

@hlissner

Become a maintainer?

Module flags

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

Packages

doom-package:lsp-treemacs if doom-module:+lsp
doom-package:treemacs
doom-package:treemacs-evil if doom-module::editor evil +everywhere
doom-package:treemacs-magit if doom-module::tools magit
doom-package:treemacs-persp if doom-module::ui workspaces
doom-package: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, doom-package: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?