emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/ui/treemacs
History
Henrik Lissner 037b018cdd
feat: add .doommodule files 
These optional dotfiles indicate the root of a module or module
group (:lang), and will later contain module metadata. They will also
serve as an alternative to packages.el and doctor.el, and will aide the
parts of the v3.0 module API concerned with resolving the current module
from a path (`doom-module-from-path`), which currently rely too heavily
on parsing path strings.

For now, however, they're simply placeholders.
2024-09-14 20:47:39 -04:00
..
.doommodule feat: add .doommodule files 2024-09-14 20:47:39 -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   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

Become a maintainer?

Module flags

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

Packages

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:

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

+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?