willbchang / ward-emacs

Make Emacs an easy to use Text Editor for English and Chinese on macOS.

Ward Emacs

_{Make Emacs an easy to use Text Editor for English and Chinese on macOS.}

Introduction

A minimal Emacs configration that you can start using easily.

MacOS Preferred Keybindings	Powerful Features	Suitable Features	Chinese Optimization
Word Processing	Org Mode	Markdown	Improved Display
Window Management	Vim Emulator	Multiple Cursor	Search with Pinyin
	Git Client	Terminal Emulator	Auto switch input method
			Compatible Keybindings

The configuration is in config.org.

Notes

• Press alt + x and type describe-, you can findout almost anything in Emacs by yourself.
• Emacs is more highly customizable than you think.
• I mainly support the version that I'm using, most of the code should work on other versions, but I don't have time to care about compatiblity. You can get help from search engine and the great emacs communities (reddit/emacs, Emacs StackExchange, emacs-china).
• Do not expect too much, and you'll be happy.

Installation

# Emacs 29
brew tap d12frosted/emacs-plus
brew install emacs-plus@29 --with-dragon-icon

# Tools
brew install ripgrep

# Font
brew tap willbchang/homebrew-cask-font-roboto-mono
brew install --cask font-roboto-mono-no-svn


# Input Source Switcher
brew tap laishulu/macism
brew install macism

git clone --depth=1 https://github.com/willbchang/ward-emacs.git ~/.config/emacs

Shortcuts

Word Processing

Moving Cursor	Features	Convention
Command + ↑	Move to the top of the file.	MacOS
Command + ↓	Move to the bottom of the file	MacOS
Command + ←	Move to the beginning of the line	MacOS
Command + →	Move to the end of the line	MacOS
Command + L	Go to line	MacOS
Option + ←	Move to the previous word	MacOS
Option + →	Move to the next word	MacOS

Selecting Text	Features	Convention
Command + A	Select all text	MacOS
Shift + ↑	Select one line up	MacOS
Shift + ↓	Select one line down	MacOS
Shift + ←	Select one character left	MacOS
Shift + →	Select one character right	MacOS
Shift + Option + ←	Select one word left	MacOS
Shift + Option + →	Select one word right	MacOS
Shift + Command + ↑	Select to top of the file	MacOS
Shift + Command + ↓	Select to bottom of the file	MacOS
Shift + Command + ←	Select to the beginning of the line	MacOS
Shift + Command + →	Select to the end of the line	MacOS

Editing Text	Features	Convention
Command + C	Copy selected text	MacOS
Command + V	Paste text from clipboard	MacOS
Command + X	Cut selected text	MacOS
Command + Z	Undo text change	MacOS
Command + Shift + Z	Redo text change	MacOS
Command + F	Search text	MacOS
Option + Delete	Delete a word back	MacOS
Command + Delete	Delete to line start	MacOS
Command + Shift + Delete	Delete entire line	Personal
Command + /	Comment or uncomment line(s)	MacOS
Shift + Option + ↑	Swap current line and previous line	Emacs (org mode only)
Shift + Option + ↓	Swap current line and next line	Emacs (org mode only)

Window Management

Window	Features	Convention
Command + Shift + W	Close Current Frame	macOS
Command + Shift + N	Create New Frame	macOS
Command + Q	Quit Emacs	macOS
Command + W	Close Current Buffer	macOS
Command + [	Go to previous Buffer	macOS
Command + ]	Go to next Buffer	macOS
Command + =	Zoom in Buffer	macOS
Command + -	Zoom out Buffer	macOS
Command + 0	Reset Zoom Buffer	macOS
Command + N	Create New Buffer	macOS
Command + S	Save Buffer	macOS
Command + R	Revert Buffer	macOS
Command + ,	Open Preferences	macOS
Command + `	Move to next Frame	macOS
Alt + `	Move to next Window	Personal
Control + `	Open Terminal Emulator	Personal

Credit

It learns from the Emacs Community.

LICENSE

AGPL-3.0