Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jcs-elpa/preview-it
Preview anything at point.
https://github.com/jcs-elpa/preview-it
emacs path preview web
Last synced: 6 days ago
JSON representation
Preview anything at point.
- Host: GitHub
- URL: https://github.com/jcs-elpa/preview-it
- Owner: jcs-elpa
- License: gpl-3.0
- Created: 2020-10-13T05:58:04.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-21T09:39:15.000Z (4 months ago)
- Last Synced: 2024-07-21T10:47:21.086Z (4 months ago)
- Topics: emacs, path, preview, web
- Language: Emacs Lisp
- Homepage:
- Size: 290 KB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://jcs-emacs.github.io/jcs-elpa/#/preview-it)
# preview-it
> Preview anything at point.
[](https://github.com/jcs-elpa/preview-it/actions/workflows/test.yml)
Preview `file`, `image`, and `website` by moving cursor on top of target.
## 🏆 Features
This package current supports viewing these items.
* File (absolute/relative)
* Image
* Url/Link
| Preview File | Preview Image |
|:-------------------|:---------------------|
|  |  |
| Preview Url | Color |
|:-------------------|:---------------------|
|  |  |
## 🔨 Usage
You can enable this feature by the following command. So it will work every time
your cursor is hovering anything that can be preview.
```
M-x preview-it-mode
```
To enabled it globally, use the following command instead.
```
M-x global-preview-it-mode
```
You can also called `preview-it` function directly to preview thing at the current
cursor's position.
## 🔧 Customization
#### 🧪 Variables
* `preview-it-delay` - Seconds delay to show preview.
* `preview-it-render-md` - Set to non-nil, render markdown file.
* `preview-it-color-text` - String to display color.
#### 🧪 Face
* `preview-it-background` - Background color of the preview buffer.
## 🛠️ Contribute
[](http://makeapullrequest.com)
[](https://github.com/bbatsov/emacs-lisp-style-guide)
[](https://www.paypal.me/jcs090218)
[](https://www.patreon.com/jcs090218)
If you would like to contribute to this project, you may either
clone and make pull requests to this repository. Or you can
clone the project and establish your own branch of this tool.
Any methods are welcome!
### 🔬 Development
To run the test locally, you will need the following tools:
- [Eask](https://emacs-eask.github.io/)
- [Make](https://www.gnu.org/software/make/) (optional)
Install all dependencies and development dependencies:
```sh
$ eask install-deps --dev
```
To test the package's installation:
```sh
$ eask package
$ eask install
```
To test compilation:
```sh
$ eask compile
```
**🪧 The following steps are optional, but we recommend you follow these lint results!**
The built-in `checkdoc` linter:
```sh
$ eask lint checkdoc
```
The standard `package` linter:
```sh
$ eask lint package
```
*📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.*
## ⚜️ License
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the 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 of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
See [`LICENSE`](./LICENSE.txt) for details.