https://github.com/jaypei/emacs-neotree

A emacs tree plugin like NerdTree for Vim.
https://github.com/jaypei/emacs-neotree

Last synced: 2 days ago
JSON representation

A emacs tree plugin like NerdTree for Vim.

• Host: GitHub
• URL: https://github.com/jaypei/emacs-neotree
• Owner: jaypei
• License: gpl-3.0
• Created: 2014-03-23T13:02:34.000Z (almost 11 years ago)
• Default Branch: dev
• Last Pushed: 2024-05-19T19:02:55.000Z (9 months ago)
• Last Synced: 2024-05-20T23:54:51.992Z (9 months ago)
• Language: Emacs Lisp
• Homepage:
• Size: 828 KB
• Stars: 1,543
• Watchers: 32
• Forks: 146
• Open Issues: 39
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# emacs-neotree

A Emacs tree plugin like NerdTree for Vim.

[![Build Status](https://travis-ci.org/jaypei/emacs-neotree.svg?branch=master)](https://travis-ci.org/jaypei/emacs-neotree)

[![MELPA Stable](http://stable.melpa.org/packages/neotree-badge.svg)](http://stable.melpa.org/#/neotree)

[![MELPA](https://melpa.org/packages/neotree-badge.svg)](https://melpa.org/#/neotree)

## Screenshots

![NeoTree-1](https://raw.githubusercontent.com/wiki/jaypei/emacs-neotree/imgs/neotree-1.png)  

## Installation

### Melpa

You can install the plugin using the packages on [melpa](http://melpa.org/).

Make sure you have something like the following in your Emacs startup file (`~/.emacs.d/init.el`, or `~/.emacs`):

```elisp

    (add-to-list 'package-archives

                 '("melpa" . "http://melpa.org/packages/"))

```

To make that take effect, either evaluate that elisp expression or restart Emacs.

Then use `M-x package-list-packages`, select `neotree` from

the list by pressing `i`, then press `x` to execute the changes. At

that point, the package will be installed.

### Source

Clone project:

```sh

$ cd /some/path

$ git clone https://github.com/jaypei/emacs-neotree.git neotree

$ cd neotree

$ git checkout dev

```

Add config to emacs:

```elisp

(add-to-list 'load-path "/some/path/neotree")

(require 'neotree)

(global-set-key [f8] 'neotree-toggle)

```

Open (toggle) NeoTree:

```

```

## Keybindings

Only in Neotree Buffer:

* `n` next line, `p` previous line。

* `SPC` or `RET` or `TAB` Open current item if it is a file. Fold/Unfold current item if it is a directory.

* `U` Go up a directory

* `g` Refresh

* `A` Maximize/Minimize the NeoTree Window

* `H` Toggle display hidden files

* `O` Recursively open a directory

* `C-c C-n` Create a file or create a directory if filename ends with a ‘/’

* `C-c C-d` Delete a file or a directory.

* `C-c C-r` Rename a file or a directory.

* `C-c C-c` Change the root directory.

* `C-c C-p` Copy a file or a directory.

## Configurations

### Theme config

NeoTree provides following themes: *classic*(default) *ascii* *arrow* *icons* *nerd*. 

Theme can be configed by setting **neo-theme**. For example, use *icons* for window 

system and *arrow* terminal.

```elisp

(setq neo-theme (if (display-graphic-p) 'icons 'arrow))

```

**Note**: For users who want to use the `icons` theme. Pls make sure you have installed the

[all-the-icons](https://github.com/domtronn/all-the-icons.el) package and its

[fonts](https://github.com/domtronn/all-the-icons.el/tree/master/fonts).

* all-the-icons theme screenshots  

![](screenshots/icons.png "neotree icons theme")

## More documentation

EmacsWiki:

[En](http://www.emacswiki.org/emacs/NeoTree)

[中文版](http://www.emacswiki.org/emacs-zh/NeoTree_%E4%B8%AD%E6%96%87wiki)