emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

doc: adding treemacs readme (#4797)

Browse source 
* fix: rebase readme too combine lsp settings

* doc:finish Sections of the README (now with +lsp!)

* fix: punctuation and wording.

Sentences should now be punctuated and the sentence at the start of
configuration now is a little easier to understand IMO

* Revert "fix: punctuation and wording."

This reverts commit b0155b02b0dd83519e192ba6951dc5eecee8130a.

* Revert "Revert "fix: punctuation and wording.""

This reverts commit 3933660c9d1c2074ac303bd5db472f315676b3dc.
This commit is contained in:
Jeetaditya Chatterjee 2021-05-24 18:47:20 +01:00 • committed by GitHub
parent eb9b7b0bbc
commit 1eb3da9fcb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 39 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

50
modules/ui/treemacs/README.org
View file

@ -15,6 +15,11 @@
* Description
[[https://github.com/Alexander-Miller/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 (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.
@ -23,21 +28,44 @@
+ =+lsp= Enable ~lsp-treemacs~ integration and add shortcuts for common commands.
** Plugins
+ [[https://github.com/Alexander-Miller/treemacs][treemacs]]
+ [[https://github.com/Alexander-Miller/treemacs/blob/master/src/extra/treemacs-evil.el][treemacs-evil]]
+ [[https://github.com/Alexander-Miller/treemacs/blob/master/src/extra/treemacs-projectile.el][treemacs-projectile]]
+ [[https://github.com/Alexander-Miller/treemacs/blob/master/src/extra/treemacs-magit.el][treemacs-magit]]
+ [[https://github.com/Alexander-Miller/treemacs/blob/master/src/extra/treemacs-persp.el][treemacs-persp]]
+ [[https://github.com/emacs-lsp/lsp-treemacs][lsp-treemacs]]
+ [[https://github.com/Alexander-Miller/treemacs/][treemacs]]
+ [[https://github.com/Alexander-Miller/treemacs/#treemacs-projectile][treemacs-projectile]]
+ =:editor evil +everywhere=
+ [[https://github.com/Alexander-Miller/treemacs/#treemacs-evil][treemacs-evil]]
+ =:tools magit=
+ [[https://github.com/Alexander-Miller/treemacs/#treemacs-magit][treemacs-magit]]
+ =:ui workspaces=
+ [[https://github.com/Alexander-Miller/treemacs/#treemacs-persptreemacs-perspective][treemacs-persp]]
+ =+lsp=
+ [[https://github.com/emacs-lsp/lsp-treemacs][lsp-treemacs]]
* Prerequisites
This module has no prerequisites.
If ~+treemacs-git-mode~ is set to ~extended~ or ~deferred~ you will need to have
~python3~ installed.
* Features
# TODO
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
# TODO
The variable ~+treemacs-git-mode~ sets the type of git integration that treemacs
has.
* Troubleshooting
# TODO
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
# Common issues and their solution, or places to look for help.