1abcf913aa
emacs-straight/org-mode@e22b4eb7aa introduced a breaking change that made it impossible to rely on .dir-locals.el to change org-mode buffers in $EMACSDIR to doom-docs-org-mode (without infinite recursion), so we used file-local variables in7e400ab. emacs-straight/org-mode@215de6176b reverted that change, so we can use .dir-locals.el again, and this is my preference, since it requires less boilerplate across our hundreds of org files. Ref: emacs-straight/org-mode@215de6176b Ref: emacs-straight/org-mode@e22b4eb7aa Revert:7e400abdc0
87 lines
3.1 KiB
Org Mode
87 lines
3.1 KiB
Org Mode
#+title: :ui treemacs
|
|
#+subtitle: A sidebar for all the things
|
|
#+created: June 09, 2018
|
|
#+since: 21.12.0 (#669)
|
|
|
|
* Description :unfold:
|
|
[[doom-package:treemacs][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
|
|
- [[doom-user:][@hlissner]]
|
|
|
|
[[doom-contrib-maintainer:][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 section will be machine generated. Don't edit it by hand.
|
|
/This module does not have a changelog yet./
|
|
|
|
* Installation
|
|
[[id:01cffea4-3329-45e2-a892-95a384ab2338][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
|
|
#+begin_quote
|
|
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
|
#+end_quote
|
|
|
|
The project bar can be opened using [[kbd:][SPC o p]].
|
|
|
|
| Keybind | Description |
|
|
|---------+------------------------------------------------------------------|
|
|
| [[kbd:][o s]] | Open a horizontal dired buffer on the currently highlighted node |
|
|
| [[kbd:][o v]] | Open a vertical dired buffer on the currently highlighted node |
|
|
|
|
* TODO Configuration
|
|
#+begin_quote
|
|
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
|
#+end_quote
|
|
|
|
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.
|
|
|
|
#+begin_quote
|
|
🚧 ~+treemacs-git-mode~ must be set before treemacs is loaded.
|
|
#+end_quote
|
|
|
|
* Troubleshooting
|
|
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
|
|
|
* Frequently asked questions
|
|
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
|
|
|
* TODO Appendix
|
|
#+begin_quote
|
|
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
|
#+end_quote
|