{"id":13466475,"url":"https://github.com/jaypei/emacs-neotree","last_synced_at":"2025-04-01T11:01:39.987Z","repository":{"id":15303677,"uuid":"18033470","full_name":"jaypei/emacs-neotree","owner":"jaypei","description":"A emacs tree plugin like NerdTree for Vim.","archived":false,"fork":false,"pushed_at":"2024-05-19T19:02:55.000Z","size":848,"stargazers_count":1543,"open_issues_count":39,"forks_count":146,"subscribers_count":32,"default_branch":"dev","last_synced_at":"2024-05-20T23:54:51.992Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Emacs Lisp","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jaypei.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-03-23T13:02:34.000Z","updated_at":"2024-05-30T01:27:47.118Z","dependencies_parsed_at":"2024-05-30T01:27:44.459Z","dependency_job_id":"b76d092b-6bc6-4b00-9b1b-90dd290b0182","html_url":"https://github.com/jaypei/emacs-neotree","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaypei%2Femacs-neotree","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaypei%2Femacs-neotree/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaypei%2Femacs-neotree/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaypei%2Femacs-neotree/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jaypei","download_url":"https://codeload.github.com/jaypei/emacs-neotree/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246558119,"owners_count":20796696,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T15:00:44.730Z","updated_at":"2025-04-01T11:01:39.954Z","avatar_url":"https://github.com/jaypei.png","language":"Emacs Lisp","funding_links":[],"categories":["Emacs Lisp"],"sub_categories":[],"readme":"# emacs-neotree\n\nA Emacs tree plugin like NerdTree for Vim.\n\n[![Build Status](https://travis-ci.org/jaypei/emacs-neotree.svg?branch=master)](https://travis-ci.org/jaypei/emacs-neotree)\n[![MELPA Stable](http://stable.melpa.org/packages/neotree-badge.svg)](http://stable.melpa.org/#/neotree)\n[![MELPA](https://melpa.org/packages/neotree-badge.svg)](https://melpa.org/#/neotree)\n\n\n## Screenshots\n\n![NeoTree-1](https://raw.githubusercontent.com/wiki/jaypei/emacs-neotree/imgs/neotree-1.png)  \n\n## Installation\n\n### Melpa\n\nYou can install the plugin using the packages on [melpa](http://melpa.org/).\n\nMake sure you have something like the following in your Emacs startup file (`~/.emacs.d/init.el`, or `~/.emacs`):\n\n```elisp\n    (add-to-list 'package-archives\n                 '(\"melpa\" . \"http://melpa.org/packages/\"))\n```\n\nTo make that take effect, either evaluate that elisp expression or restart Emacs.\n\nThen use `M-x package-list-packages`, select `neotree` from\nthe list by pressing `i`, then press `x` to execute the changes. At\nthat point, the package will be installed.\n\n\n### Source\n\nClone project:\n```sh\n$ cd /some/path\n$ git clone https://github.com/jaypei/emacs-neotree.git neotree\n$ cd neotree\n$ git checkout dev\n```\n\nAdd config to emacs:\n\n```elisp\n(add-to-list 'load-path \"/some/path/neotree\")\n(require 'neotree)\n(global-set-key [f8] 'neotree-toggle)\n```\n\nOpen (toggle) NeoTree:\n\n```\n\u003cF8\u003e\n```\n\n## Keybindings\n\nOnly in Neotree Buffer:\n\n* `n` next line, `p` previous line。\n* `SPC` or `RET` or `TAB` Open current item if it is a file. Fold/Unfold current item if it is a directory.\n* `U` Go up a directory\n* `g` Refresh\n* `A` Maximize/Minimize the NeoTree Window\n* `H` Toggle display hidden files\n* `O` Recursively open a directory\n* `C-c C-n` Create a file or create a directory if filename ends with a ‘/’\n* `C-c C-d` Delete a file or a directory.\n* `C-c C-r` Rename a file or a directory.\n* `C-c C-c` Change the root directory.\n* `C-c C-p` Copy a file or a directory.\n\n\n## Configurations\n\n### Theme config\nNeoTree provides following themes: \n- *classic* (default)\n- *ascii*\n- *arrow*\n- *icons*[^1]\n- *nerd-icons*[^2]\n- *nerd*\n\nTheme can be configed by setting **neo-theme**. For example, use *icons* for window \nsystem and *arrow* terminal.\n\n```elisp\n(setq neo-theme (if (display-graphic-p) 'icons 'arrow))\n```\n\n\n* all-the-icons theme screenshots  \n![](screenshots/icons.png \"neotree icons theme\")\n\n## More documentation\n\nEmacsWiki:\n[En](http://www.emacswiki.org/emacs/NeoTree)\n[中文版](http://www.emacswiki.org/emacs/NeoTree_%E4%B8%AD%E6%96%87wiki)\n\n\n[^1]: For users who want to use the `icons` theme. Please make sure you have installed the\n[all-the-icons](https://github.com/domtronn/all-the-icons.el) package and its\n[fonts](https://github.com/domtronn/all-the-icons.el/tree/master/fonts).\n\n[^2]: For users who want to use the `nerd-icons` theme. Please make sure you have installed the\n[nerd-icons](https://github.com/rainstormstudio/nerd-icons.el?tab=readme-ov-file) package and\none of its [fonts](https://www.nerdfonts.com/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaypei%2Femacs-neotree","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaypei%2Femacs-neotree","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaypei%2Femacs-neotree/lists"}