Skip to content

Commit

Permalink
docs: neovim & emacs
Browse files Browse the repository at this point in the history
  • Loading branch information
ryan4yin committed Jan 7, 2024
1 parent b492ffa commit e9eb3d4
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 15 deletions.
2 changes: 1 addition & 1 deletion home/base/desktop/editors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Type `:tutor`(`:Tutor` in Neovim) to learn the basics usage of vim/neovim.

## VIM's Cheetsheet

> Here only record my commonly used keyboard keys, to see a more comprehensive cheetsheet: <https://github.com/rtorr/vim-cheat-sheet>
> Here only record my commonly used keyboard keys, to see **a more comprehensive cheetsheet**: <https://github.com/rtorr/vim-cheat-sheet>
Both Emacs-Evil & Neovim are compatible with vim, sothe key-bindings described here are common in both Emacs-Evil, Neovim & vim.

Expand Down
17 changes: 8 additions & 9 deletions home/base/desktop/editors/emacs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@
- Emacs Wiki: <https://www.emacswiki.org/emacs/SiteMap>
- Awesome Emacs: <https://github.com/emacs-tw/awesome-emacs#lsp-client>

## Why emacs?

1. Explore the unknown, just for fun!
2. Org Mode
3. Lisp Coding

## Install or Update

After deploying this nix flake, run the following command to install or update emacs:
Expand All @@ -37,15 +43,6 @@ just emacs-reload
just emacs-clear
```

## Notes

1. we can run any emacs command via `M-x`(Alt + x).

## Why emacs?

1. Explore the unknown, just for fun!
2. Org Mode

## Cheetsheet

Here is the cheetsheet related to my DoomEmacs configs. Please read vim's common cheetsheet at [../README.md](../README.md) before reading the following.
Expand All @@ -54,6 +51,8 @@ Here is the cheetsheet related to my DoomEmacs configs. Please read vim's common

> Terminal(vterm) is useful in GUI mode, I use Zellij instead in terminal mode.
> We can run any emacs command via `M-x`(Alt + x).
| Action | Shortcut |
| ---------------------- | ------------- |
| Popup Terminal(vterm) | `SPC + o + t` |
Expand Down
10 changes: 5 additions & 5 deletions home/base/desktop/editors/neovim/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ For more details, visit the [AstroNvim website](https://astronvim.com/).

This document outlines neovim's configuration structure and various shortcuts/commands for efficient usage.

## Screenshots

![](/_img/astronvim_2023-07-13_00-39.webp)
![](/_img/hyprland_2023-07-29_2.webp)

## Configuration Structure

| Description | Standard Location | My Location |
Expand Down Expand Up @@ -40,11 +45,6 @@ just nvim-test
just nvim-clear
```

## Screenshots

![](/_img/astronvim_2023-07-13_00-39.webp)
![](/_img/hyprland_2023-07-29_2.webp)

## Cheetsheet

Here is the cheetsheet related to my Neovim configs. Please read vim's common cheetsheet at [../README.md](../README.md) before reading the following.
Expand Down

0 comments on commit e9eb3d4

Please sign in to comment.