Adjust eaf layer to newer eaf package #14992
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,6 +7,7 @@ | |
| - [[#features][Features:]] | ||
| - [[#install][Install]] | ||
| - [[#usage][Usage]] | ||
| - [[#configuring-applications][Configuring applications]] | ||
| - [[#configuring-key-bindings][Configuring key bindings]] | ||
| - [[#key-bindings][Key bindings]] | ||
| - [[#global][Global]] | ||
|
|
@@ -19,27 +20,49 @@ | |
| - [[#pdf-view-mode-pdf-tools][pdf-view-mode (pdf-tools)]] | ||
|
|
||
| * Description | ||
| This layer adds support for the [[https://github.com/emacs-eaf/emacs-application-framework][Emacs Application Framework (EAF)]]. | ||
|
|
||
| ** Features: | ||
| - Browse using a full-fledged browser within Emacs | ||
| - PDF viewer (with continuous scroll) | ||
| - Video player | ||
| - Image viewer | ||
| - See [[https://github.com/emacs-eaf/emacs-application-framework#launch-eaf-applications][EAF documentation]] for many more features | ||
|
|
||
| * Install | ||
| To use this configuration layer, add it to your =~/.spacemacs=. You will need to | ||
| add =eaf= to the existing =dotspacemacs-configuration-layers= list in this | ||
| file. | ||
|
|
||
| Currently the command =SPC SPC eaf-install-dependencies= no longer works, please | ||
| refer to [[https://github.com/emacs-eaf/emacs-application-framework#2-installupdate-eaf-applications-and-dependencies][install the required dependencies manually]]. | ||
|
|
||
| * Usage | ||
| ** Configuring applications | ||
| By default, all applications provided by eaf package are loaded, including: | ||
|
There was a problem hiding this comment. It is not necessary to remove applications from here, because you have added the Still, this variable is useful for users who would like to load only some of the packages by default. (You could add this explanation here) |
||
|
|
||
| - eaf-jupyter | ||
| - eaf-browser | ||
| - eaf-airshare | ||
| - eaf-file-browser | ||
| - eaf-file-manager | ||
| - eaf-file-sender | ||
| - eaf-music-player | ||
| - eaf-system-monitor | ||
| - eaf-mindmap | ||
| - eaf-org-previewer | ||
| - eaf-terminal | ||
| - eaf-netease-cloud-music | ||
| - eaf-video-player | ||
| - eaf-image-viewer | ||
| - eaf-demo | ||
| - eaf-vue-demo | ||
| - eaf-pdf-viewer | ||
| - eaf-markdown-previewer | ||
| - eaf-camera | ||
|
|
||
| To customise applications, please set =eaf=app= | ||
|
|
||
|
|
||
| ** Configuring key bindings | ||
| Configuration of EAF key bindings works in a different way than normally in Spacemacs. | ||
|
There was a problem hiding this comment. As mentioned by @MatthewZMD, some keybindings might be added only conditionally. As checking all these bindings is a lot of work, you could simply add a warning about it. And add a request to report keybinding issues. |
||
|
|
||
|
|
@@ -48,14 +71,14 @@ required to make leader keys in EAF buffers behave as expected in Spacemacs. | |
| Therefore it is recommended to keep these default (major-mode-)leader | ||
| keybindings. | ||
|
|
||
| For information about configuration of other key bindings for EAF, see [[https://github.com/emacs-eaf/emacs-application-framework/wiki/Keybindings][here]]. | ||
|
|
||
| If you do want to modify the leader keys, then information about the tricks | ||
| implemented in this layer can be found [[https://github.com/emacs-eaf/emacs-application-framework/issues/498][here]] and [[https://github.com/emacs-eaf/emacs-application-framework/pull/500][here]]. | ||
|
|
||
| * Key bindings | ||
| Except for the few Spacemacs specific modifications listed below, all EAF | ||
| keybindings are documented [[https://github.com/emacs-eaf/emacs-application-framework/wiki/Keybindings][here.]] | ||
|
|
||
| Use ~SPC t k m~ to [[https://develop.spacemacs.org/doc/DOCUMENTATION.html#which-key-persistent][show the EAF key bindings persistently in which-key]], or use | ||
| ~SPC h d K~ to show the `eaf-mode-map` in a separate buffer. | ||
|
|
@@ -65,7 +88,7 @@ Use ~SPC t k m~ to [[https://develop.spacemacs.org/doc/DOCUMENTATION.html#which- | |
|
|
||
| | Key binding | Description | | ||
| |-------------+-------------------------------------------------------------------------------| | ||
| | ~SPC a a f~ | EAF open file ([[https://github.com/emacs-eaf/emacs-application-framework#launch-eaf-applications][see EAF doc for supported file types]]) | | ||
| | ~SPC a a s~ | EAF open system monitor | | ||
| | ~SPC a a M~ | EAF open musik player | | ||
| | ~SPC t k m~ | Show available key commands in which-key (read [[https://develop.spacemacs.org/doc/DOCUMENTATION.html#which-key][here]] for more details) | | ||
|
|
@@ -76,7 +99,7 @@ Use ~SPC t k m~ to [[https://develop.spacemacs.org/doc/DOCUMENTATION.html#which- | |
| | Key binding | Description | | ||
| |---------------+---------------------------------------------------------------------------------------| | ||
| | ~SPC a a b o~ | Open url in new buffer | | ||
| | ~SPC a a b s~ | Search with [[https://github.com/emacs-eaf/emacs-application-framework/wiki/Customization#default-search-engine][your favorite search engine]]. Defaults to symbol at point or region string | | ||
| | ~SPC a a b b~ | Open bookmark in new buffer | | ||
| | ~SPC a a b h~ | Search and open buffer from history | | ||
|
|
||
|
|
@@ -97,7 +120,7 @@ Use ~SPC t k m~ to [[https://develop.spacemacs.org/doc/DOCUMENTATION.html#which- | |
| | ~C-s~ | Search/search find next (to enter new search prefix with ~C-g~ | | ||
| | ~C-r~ | Search find previous | | ||
| | ~SPC m h~ | Open new buffer from history | | ||
| | ~SPC m s~ | Search web with [[https://github.com/emacs-eaf/emacs-application-framework/wiki/Customization#default-search-engine][favorite search engine]] | | ||
|
|
||
| *** PDF-viewer | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| ;;; config.el --- (const eaf configuration file | ||
| ;; | ||
| ;; Copyright (c) 2021 Sylvain Benner & Contributors | ||
| ;; | ||
| ;; Author: Leslie Huang <lesliebinbin19900129@gmail.com> | ||
| ;; URL: https://github.com/syl20bnr/spacemacs | ||
| ;; | ||
| ;; This file is not part of GNU Emacs. | ||
| ;; | ||
| ;; 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 <http://www.gnu.org/licenses/>. | ||
|
|
||
| (spacemacs|defc eaf-apps | ||
| '(eaf-jupyter | ||
| eaf-browser | ||
| eaf-airshare | ||
| eaf-file-browser | ||
| eaf-file-manager | ||
| eaf-file-sender | ||
| eaf-music-player | ||
| eaf-system-monitor | ||
| eaf-mindmap | ||
| eaf-org-previewer | ||
| eaf-terminal | ||
| eaf-netease-cloud-music | ||
| eaf-video-player | ||
| eaf-image-viewer | ||
| eaf-demo | ||
| eaf-vue-demo | ||
| eaf-pdf-viewer | ||
| eaf-markdown-previewer | ||
| eaf-camera) | ||
| "The applications loaded from EAF package" | ||
| '(set | ||
| (const eaf-jupyter) | ||
| (const eaf-browser) | ||
| (const eaf-airshare) | ||
| (const eaf-file-browser) | ||
| (const eaf-file-manager) | ||
| (const eaf-file-sender) | ||
| (const eaf-music-player) | ||
| (const eaf-system-monitor) | ||
| (const eaf-mindmap) | ||
| (const eaf-org-previewer) | ||
| (const eaf-terminal) | ||
| (const eaf-netease-cloud-music) | ||
| (const eaf-video-player) | ||
| (const eaf-image-viewer) | ||
| (const eaf-demo) | ||
| (const eaf-vue-demo) | ||
| (const eaf-pdf-viewer) | ||
| (const eaf-markdown-previewer) | ||
| (const eaf-camera)) | ||
| 'eaf) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new commands
eaf-installandeaf-install-and-updatework perfectly fine