Emacs configuration works across all OSs
Emacs configuration works across all OSs
This is Jen-Chieh Shen's emacs configuration started from Casey Muratori's Emacs configuration. It has been repeatedly utilized and modified since 2015 and is now very different from his configuration.
I wouldn't claim this is the best Emacs config, but this is the best config to myself. If you wish to learn Emacs, this could be a good start, because this configuration has been rewritten basically from scratch. Hopefully, this config will help someone who is new or struggle to Emacs. This configuration should work on most OSs, indicating Windows, macOS, and Linux.
Emacs itself supports multiple programming languages. I managed all the programming languages I personally used. I dabble in numerous technologies, incorporating hardware, firmware, and software. Here is the list of programming languages I know and are extended from this configuration.
This configuration polished and goes toward to the modern text editor, or even better, it goes beyond modern IDE. e.g. Atom, Brackets, Sublime Text 2 or 3, Visual Studio Code, etc.
Table of Contents
I have experienced many different kinds of IDEs and text editors. But Iβve had a hard time finding the best tool to use. Iβve jumped from one working field to another trying to find something that suits my needs. So instead of struggling with the tool itself, I chose Emacs and configured the entire thing from scratch, to suit my needs.
Here are a few goals that I want this config to accomplish.
Having these implementations makes my life easier, and having a genuinely portable workspace, which is great because it lets me work on different machines efficiently, without having to get used to a new IDE.
Here is the list of few essential and recent changes to this configuration.
9.0.2
- Replace package topsy
with breadcrumb-mode
for better UX8.2.2
- Add emp
as the default Music Player8.2.1
- Replace package docstr
with ts-docstr
for better parsing capability8.2.0
- Drop support for Emacs 27.x8.1.0
- Remove config tabify/untabify save, and replace it with whitespace-cleanup-mode
.8.0.1
- Switch from ivy
to vertico
.8.0.0
- Move everything to .emacs.d
. (#32)7.1.0
- Replace quelpa
with github-elpa
.7.0.0
- Switch from quickhelp to box for company frontend.6.5.0
- Add pinned archive feature to package module.To install, clone this repo to ~/.emacs.d
, i.e. ensure that the init.el
contained in this repo ends up at ~/.emacs.d/init.el
:
git clone https://github.com/jcs-emacs/jcs-emacs ~/.emacs.d
Then startup Emacs; will automatically install all necessary packages due to this configuration.
βΌοΈ[ATTENTION]βΌοΈ -- MAKE SURE YOU INSTALLED THE CORRECT VERSION OF EMACS!
(in seconds)
The average startup time for this configuration is around 15
to 25
seconds.
You can use the command emacs-init-time
to check the startup time on your machine.
Not quite sure what causes that much performance, hopefully, I'm able to lower
the startup time down to 5
to 15
seconds.
Edit 1: After version 5.3.2
, the average startup time is around 5
to 15
seconds. Solved this issue by removing the unnecessary require
keyword load file
and using :defer
keyword with use-package
package to delay some packages
load time.
π P.S. Here is a great article about Speeding Up Emacs written by Anurag Peshne.
Edit 2: Using esup package to test and
optimize the configuration. Call package-refresh-contents
only when package
installation is needed. By doing the thing, lower the startup time from around
4
to 8
seconds.
π P.S. Some good hints from one StackExchange question, What can I do to speed up my start-up? answered by Jordon Biondo.
π P.S. The above cases are tested on Windows. Other OSs are not Windows should start within a second.
Here is the list of the major highlights of this configuration. Hope you would like my taste!
This is the list of features that are built-in to this configuration. These features are heavily based on my personal habits, and so these could be very tiny things. But I believe details make things better and make life smoother.
CHANGELOG
file using template.mark
and unmark
multiple cursor.LICENSE
file using template.C-<up>
and C-<down>
to navigate previous and next blank line.org-mode
's table easier by using arrow keys.undo-tree-visualizer
at the other window.A list of package archives that this configuration uses.
π P.S. Here is a good talk comparing all package archives from a StackExchange question, What are the practical differences between the various Emacs Package Repositories? answered by Tikhon Jelvis.
Here is the list of all packages that powered and made this configuration works. Thanks to all the package maintainers; this configuration cannot be made without them, and if you wish to support them, you can go to this elisp-maintainers repo/site and search for the maintainer you want to support. There should be some kind of methods to support the maintainer you wish to.
You can customize the configuration by editing the file located at
~/.emacs.d/site-lisp/config.el
. You should put all your own customize code
there, then other than that are the core files.
Here is the list of Frequently Asked Questions.
If you would like to contribute to this project, you may 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!
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
See LICENSE
for details.