feat(readme): update mapping links
This commit is contained in:
parent
fafe70eb36
commit
7984d760a1
2 changed files with 32 additions and 19 deletions
8
.markdownlint.yaml
Normal file
8
.markdownlint.yaml
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
MD033:
|
||||||
|
# Allowed elements
|
||||||
|
allowed_elements: [p, details, summary, a, img, h1]
|
||||||
|
|
||||||
|
# MD013/line-length - Line length
|
||||||
|
MD013:
|
||||||
|
# Number of characters
|
||||||
|
line_length: 120
|
43
readme.md
43
readme.md
|
@ -11,13 +11,14 @@
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
CosmicNvim is a lightweight and opinionated Neovim config for web development, specifically designed to provide a 💫 COSMIC programming experience!
|
CosmicNvim is a lightweight and opinionated Neovim config for web development,
|
||||||
|
specifically designed to provide a 💫 COSMIC programming experience!
|
||||||
|
|
||||||
<img width="2531" alt="Screen Shot 2021-12-19 at 1 25 24 PM" src="https://user-images.githubusercontent.com/3721204/146691358-82a6ff64-1942-4351-ac53-e710a3e48700.png">
|
<img width="2531" alt="Screen Shot 2021-12-19 at 1 25 24 PM" src="https://user-images.githubusercontent.com/3721204/146691358-82a6ff64-1942-4351-ac53-e710a3e48700.png">
|
||||||
|
|
||||||
## 🚀 Stellar Features
|
## 🚀 Stellar Features
|
||||||
|
|
||||||
#### Native LSP
|
### Native LSP
|
||||||
|
|
||||||
Full featured native LSP functionality!
|
Full featured native LSP functionality!
|
||||||
|
|
||||||
|
@ -27,7 +28,7 @@ Full featured native LSP functionality!
|
||||||
- 🚨 Statusline diagnostics
|
- 🚨 Statusline diagnostics
|
||||||
- 🔧 Formatting/linting thanks to [null-ls](https://github.com/jose-elias-alvarez/null-ls.nvim)
|
- 🔧 Formatting/linting thanks to [null-ls](https://github.com/jose-elias-alvarez/null-ls.nvim)
|
||||||
|
|
||||||
##### Additional features
|
#### Additional features
|
||||||
|
|
||||||
- Custom rename and code action popups via [Cosmic-UI](https://github.com/CosmicNvim/cosmic-ui)
|
- Custom rename and code action popups via [Cosmic-UI](https://github.com/CosmicNvim/cosmic-ui)
|
||||||
- Amazing default theme via [tokyonight.nvim](https://github.com/folke/tokyonight.nvim)
|
- Amazing default theme via [tokyonight.nvim](https://github.com/folke/tokyonight.nvim)
|
||||||
|
@ -46,7 +47,8 @@ Full featured native LSP functionality!
|
||||||
- Additional custom highlighting
|
- Additional custom highlighting
|
||||||
- Floating windows for references, renaming, diagnostics, code actions and more!
|
- Floating windows for references, renaming, diagnostics, code actions and more!
|
||||||
|
|
||||||
_While CosmicNvim is geared specifically toward TypeScript/JavaScript development, it should be able to provide a great experience with any LSP supported language._
|
_While CosmicNvim is geared specifically toward TypeScript/JavaScript development, it should be able to provide a great
|
||||||
|
experience with any LSP supported language._
|
||||||
|
|
||||||
## 🛠 Installation
|
## 🛠 Installation
|
||||||
|
|
||||||
|
@ -61,10 +63,12 @@ _While CosmicNvim is geared specifically toward TypeScript/JavaScript developmen
|
||||||
|
|
||||||
#### Install
|
#### Install
|
||||||
|
|
||||||
```
|
```bash
|
||||||
$ cd ~/.config
|
cd ~/.config
|
||||||
$ git clone git@github.com:CosmicNvim/CosmicNvim.git nvim
|
# back up current config
|
||||||
$ nvim .
|
cp -r nvim nvim.backup
|
||||||
|
git clone git@github.com:CosmicNvim/CosmicNvim.git nvim
|
||||||
|
nvim .
|
||||||
```
|
```
|
||||||
|
|
||||||
Additional CosmicNvim installation [details](https://github.com/CosmicNvim/CosmicNvim/wiki/Installation).
|
Additional CosmicNvim installation [details](https://github.com/CosmicNvim/CosmicNvim/wiki/Installation).
|
||||||
|
@ -101,25 +105,26 @@ CosmicNvim comes with first-class support for the following themes:
|
||||||
|
|
||||||
## ✨ Cosmic Commands
|
## ✨ Cosmic Commands
|
||||||
|
|
||||||
#### Update CosmicNvim
|
### Update CosmicNvim
|
||||||
|
|
||||||
```
|
```vimcommand
|
||||||
:CosmicUpdate
|
:CosmicUpdate
|
||||||
```
|
```
|
||||||
|
|
||||||
By default, this will assume the Cosmic git directory is placed at `vim.fn.stdpath('config')`, i.e. `~/.config/nvim`. Otherwise, you may define the shell environment variable `COSMICNVIM_INSTALL_DIR`.
|
By default, this will assume the Cosmic git directory is placed at `vim.fn.stdpath('config')`, i.e. `~/.config/nvim`.
|
||||||
|
Otherwise, you may define the shell environment variable `COSMICNVIM_INSTALL_DIR`.
|
||||||
|
|
||||||
#### Clear cache and sync plugins
|
### Clear cache and sync plugins
|
||||||
|
|
||||||
```
|
```vimcommand
|
||||||
:CosmicReloadSync
|
:CosmicReloadSync
|
||||||
```
|
```
|
||||||
|
|
||||||
Useful for changing themes or updating plugins on the fly!
|
Useful for testing themes or plugins on the fly!
|
||||||
|
|
||||||
#### Reload user config
|
### Reload user config
|
||||||
|
|
||||||
```
|
```vimcommand
|
||||||
:CosmicReload
|
:CosmicReload
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -127,11 +132,11 @@ Useful for non-plugin related changes such as editor settings or mappings.
|
||||||
|
|
||||||
## 🗺 Default Mappings
|
## 🗺 Default Mappings
|
||||||
|
|
||||||
[File navigation](./lua/cosmic.plugins/telescope/mappings.lua)
|
[File navigation](./lua/cosmic/plugins/telescope/mappings.lua)
|
||||||
|
|
||||||
[File explorer](./lua/cosmic.plugins/nvim-tree/mappings.lua)
|
[File explorer](./lua/cosmic/plugins/nvim-tree/mappings.lua)
|
||||||
|
|
||||||
[Terminal](./lua/cosmic.plugins/terminal/mappings.lua)
|
[Terminal](./lua/cosmic/plugins/terminal/mappings.lua)
|
||||||
|
|
||||||
[LSP](./lua/cosmic/lsp/mappings.lua)
|
[LSP](./lua/cosmic/lsp/mappings.lua)
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue