docs(:ui): update READMEs to new format
This commit is contained in:
Henrik Lissner
Henrik Lissner
parent
6da20e45bd
commit
b5a2aa48fe
25 changed files with 1533 additions and 922 deletions
|
|
@ -1,71 +1,89 @@
|
|||
#+TITLE: ui/treemacs
|
||||
#+DATE: April 5, 2021
|
||||
#+SINCE: v2.0.4
|
||||
#+STARTUP: inlineimages nofold
|
||||
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::ui treemacs][Issues]] ↖ [[doom-module-source:ui/treemacs][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||
--------------------------------------------------------------------------------
|
||||
#+TITLE: :ui treemacs
|
||||
#+SUBTITLE: A sidebar for all the things
|
||||
#+CREATED: June 09, 2018
|
||||
#+SINCE: 21.12.0 (#669)
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#maintainers][Maintainers]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#prerequisites][Prerequisites]]
|
||||
- [[#features][Features]]
|
||||
- [[#configuration][Configuration]]
|
||||
- [[#troubleshooting][Troubleshooting]]
|
||||
* 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:
|
||||
|
||||
* 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)
|
||||
- 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
|
||||
+ This module has no dedicated maintainers.
|
||||
- [[doom-user:][@hlissner]]
|
||||
|
||||
** Module Flags
|
||||
+ =+lsp= Enable ~lsp-treemacs~ integration and add shortcuts for common commands.
|
||||
[[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Plugins
|
||||
+ [[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]]
|
||||
** Module flags
|
||||
- +lsp ::
|
||||
Enable ~lsp-treemacs~ integration and add shortcuts for common commands.
|
||||
|
||||
* Prerequisites
|
||||
If ~+treemacs-git-mode~ is set to ~extended~ or ~deferred~ you will need to have
|
||||
~python3~ installed.
|
||||
** 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]]
|
||||
|
||||
* Features
|
||||
The project bar can be opened using =SPC o p=.
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
||||
| 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 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
|
||||
|
||||
* Configuration
|
||||
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.
|
||||
|
||||
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.
|
||||
#+begin_quote
|
||||
🚧 ~+treemacs-git-mode~ must be set before treemacs is loaded.
|
||||
#+end_quote
|
||||
|
||||
the default being simple
|
||||
* Troubleshooting
|
||||
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
||||
|
||||
This must be set before treemacs has loaded.
|
||||
* Frequently asked questions
|
||||
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
||||
|
||||
* TODO Troubleshooting
|
||||
# Common issues and their solution, or places to look for help.
|
||||
* TODO Appendix
|
||||
#+begin_quote
|
||||
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
||||
#+end_quote
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue