Giter VIP home page Giter VIP logo

breadcrumb-pr's Introduction

M-x breadcrumb-mode

screenshot

Usage

Breadcrumbs are sequences of short strings indicating where you are in some big tree-like maze that is probably your code. Hopefully the screenshot above clears it up.

  • M-x breadcrumb-mode is global mode. Will try to turn itself on conservatively and only if there's a project.

  • M-x breadcrumb-local-mode is a buffer-local minor mode, if you don't want the default heuristics for turning it on everywhere.

There's not much more to it. Breadcrumb will try to query imenu.el and project.el for the best information.

Installation

For now, just download the breadcrumb.el file and load it somehow.

More usage

If you want some leet modeline you may also manually put the mode-line constructs

(:eval (breadcrumb-imenu-crumbs))

and

(:eval (breadcrumb-project-crumbs))

in your settings of the mode-line-format or header-line-format variables.

Tweaks

The shape and size of each breadcrumb groups may be tweaked via breadcrumb-imenu-max-length, breadcrumb-project-max-length, breadcrumb-imenu-crumb-separator, and breadcrumb-project-crumb-separator.

The structure each of the breadcrumbs varies depending on whether either project.el and imenu.el (or both) can do useful things for your buffer.

For Project breadcrumbs, this depends on whether project.el's project-current can guess what project the current buffer belongs to.

For Imenu breadcrumbs, this varies. Depending on the major-mode author's taste, the Imenu tree (in variable imenu--index-alist) may have different structure. Sometimes, minor mode also tweak the Imenu tree in useful ways. For example, with recent Eglot (I think Eglot 1.14+), managed buffers get extra region info added to it, which makes Breadcrumb show "richer" paths.

breadcrumb-pr's People

Contributors

joaotavora avatar ruijieyu avatar phikal avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.