Git Product home page Git Product logo

topsy.el's Introduction

topsy.el

This library shows a sticky header at the top of the window. The header shows which definition the top line of the window is within. It’s intended as a simple alternative to semantic-stickyfunc-mode. It’s especially helpful when, for example, browsing a list of occur results: when a line is in the middle of a definition, and the top of the definition is beyond the top of the window, topsy shows what definition the line is in.

Mode-specific functions may be added to topsy-mode-functions.

NOTE: For Org mode buffers, please use org-sticky-header.

Screenshots

images/screenshot.png

Contents

Installation

MELPA

This library is not on MELPA yet.

Quelpa

The recommended way to install is with quelpa-use-package, like this:

;; Install and load `quelpa-use-package'.
(package-install 'quelpa-use-package)
(require 'quelpa-use-package)

(use-package topsy
  :quelpa (topsy :fetcher github :repo "alphapapa/topsy.el")
  :hook (prog-mode . topsy-mode))

Manual

Put topsy.el in your load-path, then:

(require 'topsy)

(add-hook 'prog-mode-hook #'topsy-mode)

Usage

Run command topsy-mode. You may add it to appropriate hooks, such as prog-mode-hook.

Tips

  • You can customize settings in the topsy group.

Changelog

0.1-pre

Not yet tagged.

Development

Bug reports, feature requests, suggestions — oh my!

There is currently only one function in topsy-mode-functions, one which returns the line that beginning-of-defun goes to. It should be useful in many major modes, but suggestions for additional, mode-specific functions are welcome.

License

GPLv3

topsy.el's People

Contributors

alphapapa avatar aspiers avatar

Watchers

James Cloos 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.