Repository files navigation

An inline pop-up library for Emacs Lisp.

See the docstrings ofquick-peek-show andquick-peek-hide.

Complex programs may need to use the lower-levelquick-peek-overlay-ensure-at,quick-peek-overlay-contents, andquick-peek-overlay-update methods.

See docstrings ofquick-peek-background-face,quick-peek-border-face, andquick-peek-padding-face.

If you would like to contribute to this project, you may eitherclone and make pull requests to this repository. Or you canclone the project and establish your own branch of this tool.Any methods are welcome!

To run the test locally, you will need the following tools:

• Eask
• Make (optional)

Install all dependencies and development dependencies:

eask install-deps --dev

To test the package's installation:

eask packageeask install

To test compilation:

eask compile

🪧 The following steps are optional, but we recommend you follow these lint results!

The built-incheckdoc linter:

eask lint checkdoc

The standardpackage linter:

eask lint package

📝 P.S. For more information, find the Eask manual athttps://emacs-eask.github.io/.

This program is free software; you can redistribute it and/or modifyit under the terms of the GNU General Public License as published bythe Free Software Foundation, either version 3 of the License, or(at your option) any later version.

This program is distributed in the hope that it will be useful,but WITHOUT ANY WARRANTY; without even the implied warranty ofMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See theGNU General Public License for more details.

You should have received a copy of the GNU General Public Licensealong with this program. If not, seehttps://www.gnu.org/licenses/.

SeeLICENSE for details.