Table of Contents

• Description
• Install
• Usage
• Customize
• Information
  • Community
  • Contribution
  • Migration
  • License
  • Author
  • Contributors
  • Special Thanks

Description

Interactive side-bar feature for init.el using leaf.el.

Install

(leaf leaf-tree
  :ensure t
  :config ((imenu-list-size . 30)
           (imenu-list-position . 'left)))

Usage

M-x leaf-tree-mode

Customize

leaf-tree-flat

Non-nil means make leaf-tree flat.

leaf-tree-click-group-to-hide

Non-nil means hide child leaf-tree when click group line.

As this package built on imenu-list, please see also the package README.

Information

Community

All feedback and suggestions are welcome!

You can use github issues, but you can also use Slack if you want a more casual conversation.

Contribution

We welcome PR!

Require tools for testing

• cask
  • install via brew

    brew install cask
            

  • manual install

    cd ~/
    hub clone cask/cask
    export PATH="$HOME/.cask/bin:$PATH"
            

Running test

Below operation flow is recommended.

make                              # Install git-hooks in local .git

git branch [feature-branch]       # Create branch named [feature-branch]
git checkout [feature-branch]     # Checkout branch named [feature-branch]

# <edit loop>
emacs leaf-tree.el                # Edit something you want

make test                         # Test leaf-tree via multi version Emacs
git commit -am "brabra"           # Commit (auto-run test before commit)
# </edit loop>

hub fork                          # Create fork at GitHub
git push [user] [feature-branch]  # Push feature-branch to your fork
hub pull-request                  # Create pull-request

Migration

License

General Public License Version 3 (GPLv3)
Copyright (c) Naoya Yamashita - https://conao3.com
https://github.com/conao3/leaf-tree.el/blob/master/LICENSE

Author

• Naoya Yamashita (conao3)

Contributors