Skip to content

Commit

Permalink
format: trim whitespace
Browse files Browse the repository at this point in the history
  • Loading branch information
practicalli-johnny committed Jun 22, 2024
1 parent dbfb3ee commit 0ea32cd
Show file tree
Hide file tree
Showing 35 changed files with 196 additions and 219 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
- basics: spell check overview
- configuration: alternative community configurations
- reference: link to intro to lua from codecademy

### Changed
- ci: spell lychee & repository trufflehog linters warn only (false positives)
- intro: update fennel with nfnl project, replacing aniseed
Expand All @@ -38,7 +38,7 @@
- overrides: recommend AstroNvim v4 in announce block
- intro: simplify & reorder introduction
- install: expand requirements to include kitty terminal
- mkdocs: dark theme scheme `teal` & accent `deep purple`
- mkdocs: dark theme scheme `teal` & accent `deep purple`
- basics: astronvim file, buffer, window and tap page
- intro: use practial.li/writing-tips link
- install: use practial.li/clojure/install link
Expand Down
13 changes: 6 additions & 7 deletions docs/install/multiple-configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Add alias to `.bashrc` for Bash shell or `.zshrc` for Zsh
Create a `.config/shell-aliases` file containing all shell aliases when often switching between different shells, avoiding the need to define aliases twice

Source the `.config/shell-aliases` file from within `.bashrc` or `.zshrc`

=== "Zsh"
```shell title=".zshrc"
# Shell Aliases
Expand All @@ -55,19 +55,19 @@ Source the `.config/shell-aliases` file from within `.bashrc` or `.zshrc`

## Neovim config selector

Create a shell function to popup a menu with the list of available Neovim configurations, defined in `~/.config` where the configuration directories are prefixed with `nvim-`, e.g. `~/.config/nvim-astro/`
Create a shell function to popup a menu with the list of available Neovim configurations, defined in `~/.config` where the configuration directories are prefixed with `nvim-`, e.g. `~/.config/nvim-astro/`

![Neovim Config Fuzy Selector](https://github.com/practicalli/graphic-design/blob/live/editors/neovim/screenshots/neovim-config-selector-fuzzy-find-config-list-dark.png?raw=true){loading=lazy}

!!! EXAMPLE "Neovim Config Fuzzy Finder"

```shell title=".local/bin/nvim-fuzy-find"
nvim-fuzy-find() {
# All config paths are prefixed with ~/.config/nvim-
local config=$(fdfind --max-depth 1 --glob 'nvim-*' ~/.config | fzf --prompt="Neovim Configs > " --height=15% --layout=reverse --border --exit-0)

[[ -z $config ]] && echo "No config selected, Neovim not starting" && return

# Open Neovim with selected config
NVIM_APPNAME=$(basename $config) nvim $@
}
Expand All @@ -77,8 +77,7 @@ Create a shell function to popup a menu with the list of available Neovim config
Add the Neovim config directory names from `~/.config/`
```shell title=".local/bin/nvim-selector"
nvim-selector() {
select config in nvim-astro nvim-astronvim-template nvim-lazyvim nvim-kickstart
select config in nvim-astro nvim-astronvim-template nvim-lazyvim nvim-kickstart
do NVIM_APPNAME=nvim-$config nvim $@; break; done
}
```

9 changes: 4 additions & 5 deletions docs/install/neovide.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ Neovide provides a GUI for Neovim and supports the use of AstroNvim community co

[Download the MacOSX dmg.zip file](https://github.com/neovide/neovide/releases/latest/download/neovide.dmg.zip)

Extract the .zip file
Extract the .zip file

Run the extracted dmg file and use the install wizard to copy Neovide to the Applications directory.

Create symbolic link from Neovide install to `~/.local/bin`
Create symbolic link from Neovide install to `~/.local/bin`

```bash
ln -s /Applications/neovide.app/Contents/MacOS/neovide ~/.local/bin/neovide
Expand Down Expand Up @@ -81,11 +81,10 @@ The `guifont` Neovim option is used to set a font family and size specifically f
-- configure general options: vim.opt.<key>
opt = {
guifont = "Fira Code:h16", -- neovide font family & size (height)
},
},
},
},
}
}
```

![Neovide Gui Screenshot](https://neovide.dev/assets/BasicScreenCap.png){loading=lazy}

42 changes: 21 additions & 21 deletions docs/install/neovim.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Install the following tools to support Neovim and AstroNvim
??? INFO "AstroNvim requires node.js"
AstroNvim uses Mason to install LSP servers, format and lint tools. Many of the LSP servers require node.

[Node.js install - Practicalli Engineering Playbook](https://practical.li/engineering-playbook/programming-languages/javascript/nodejs/){target=_blank}
[Node.js install - Practicalli Engineering Playbook](https://practical.li/engineering-playbook/programming-languages/javascript/nodejs/){target=_blank}


=== "Debian Packages"
Expand Down Expand Up @@ -76,7 +76,7 @@ Install from the [:fontawesome-brands-github: Neovim GitHub releases](https://gi


=== "MacOSX Homebrew"

Install from Homebrew or via the Neovim Release page

**Homebrew**
Expand All @@ -95,21 +95,21 @@ Install from the [:fontawesome-brands-github: Neovim GitHub releases](https://gi
```

Make a local apps directory for neovim (and other things like node.js, etc.)

```bash
mkdir -P ~/.local/apps
```

Extract the neovim archive

```bash
tar zvxf nvim-macos.tar.gz -C ~/.local/apps/
```
Create the `~/.local/bin/nvim` symbolic link to include Neovim on the OS execution path

Create the `~/.local/bin/nvim` symbolic link to include Neovim on the OS execution path

> `echo $PATH` to check `.local/bin` is included in the execution the path by the Operating System command line shell

```bash
ln -s ~/.local/apps/nvim-macos/bin/nvim ~/.local/bin/nvim
```
Expand All @@ -125,25 +125,25 @@ Install from the [:fontawesome-brands-github: Neovim GitHub releases](https://gi
2. Download **nvim-macos.tar.gz**
3. Run `xattr -c ./nvim-macos.tar.gz` (to avoid "unknown developer" warning)
4. Make local apps directory for neovim (and other things like node.js, etc.)

```shell
mkdir -P ~/.local/apps
```

5. Extract the neovim download

```shell
tar zvxf nvim-macos.tar.gz -C ~/.local/apps/
```

6. Create nvim symbolic link in `~/.local/bin` to include Neovim on the OS execution path (check `.local/bin` is added to the execution the path by the Operating System command line shell)

```shell
ln -s ~/.local/apps/nvim-macos/bin/nvim ~/.local/bin/nvim
```

=== "Debian Package"

!!! INFO "Linux version only packaged as AppImage from Neovim 0.9 onward"

A `.deb` file can be created after [building Neovim from source](https://github.com/neovim/neovim/blob/master/BUILD.md).
Expand All @@ -152,7 +152,7 @@ Install from the [:fontawesome-brands-github: Neovim GitHub releases](https://gi
=== "Build from Source"

[:fontawesome-brands-github: Neovim build guide](https://github.com/neovim/neovim/blob/master/BUILD.md){target=_blank .md-button}

[:fontawesome-brands-github: Neovim Build Prerequisites for each operating system](https://github.com/neovim/neovim/wiki/Building-Neovim#build-prerequisites)

??? INFO "Debian Packages"
Expand Down Expand Up @@ -200,7 +200,7 @@ Clone the [Practicalli Astro](https://github.com/practicalli/astro) config or cr
```

??? HINT "Multiple Neovim Configurations"
Clone the configuration to a unique name within `~/.config` directory.
Clone the configuration to a unique name within `~/.config` directory.

```shell
git clone https://github.com/practicalli/astro.git ~/.config/nvim-astro
Expand All @@ -216,21 +216,21 @@ Clone the [Practicalli Astro](https://github.com/practicalli/astro) config or cr
[:fontawesome-solid-book-open: Configure shell alias and selectors](multiple-configurations/#configure-shell-alias){target=_blank} to simplify the command to run a specific configuration.

??? INFO "AstroNvim Template"
[:fontawesome-brands-github: AstroNvim template repository](https://github.com/AstroNvim/template) provide a general configuration for Neovim.
[:fontawesome-brands-github: AstroNvim template repository](https://github.com/AstroNvim/template) provide a general configuration for Neovim.

[:fontawesome-brands-github: AstroNvim Community](https://github.com/AstroNvim/astrocommunity/) repository provides plugin configs to make it easier to extend the general feature of AstroNvim.


## Neovim Plugins

Enter `nvim` command in a terminal to launch Neovim and install all the plugins from the Practicalli Astro configuration.
Enter `nvim` command in a terminal to launch Neovim and install all the plugins from the Practicalli Astro configuration.

!!! NOTE "Run Neovim"
```shell
nvim
```

Lazy plugin manager runs automatically and installs all the plugins defined in the Neovim configuration.
Lazy plugin manager runs automatically and installs all the plugins defined in the Neovim configuration.

Treesitter will prompt to compile its language parsers.

Expand All @@ -239,7 +239,7 @@ Treesitter will prompt to compile its language parsers.

??? INFO "Unattended post install"
Use the `--headless` Neovim flag to install plugins without running whole Neovim editor user interface.

```shell
nvim --headless
```
Expand All @@ -249,7 +249,7 @@ Treesitter will prompt to compile its language parsers.

Troubleshoot the Neovim configuration and supporting tools by running the [:globe_with_meridians: Neovim Heath Check](https://neovim.io/doc/user/health.html){target=_blank}.

Use the `:checkhealth` command in Neovim or start Neovim with the Health Check command.
Use the `:checkhealth` command in Neovim or start Neovim with the Health Check command.

!!! EXAMPLE "Run Neovim and start Health Check"
```shell
Expand All @@ -267,4 +267,4 @@ Review the warnings and install tooling that is required for languages that will
!!! HINT "Ignore Provider Warnings"
It is safe to ignore language provider warnings.

[Language Providers can be disabled](/neovim/reference/neovim/language-providers/) in the Neovim configuration to remove the warnings from `:checkhealth` report.
[Language Providers can be disabled](/neovim/reference/neovim/language-providers/) in the Neovim configuration to remove the warnings from `:checkhealth` report.
10 changes: 4 additions & 6 deletions docs/install/tools-fonts.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ Neovim runs in a terminal, so using Kitty (or iTerm2 - MacOSX only) are good opt

[:globe_with_meridians: Kitty Terminal - Practicalli Engineering Playbook](https://practical.li/engineering-playbook/command-line/kitty-terminal/) provides examples of using Nerd Fonts or Nerd Font symbols with the Kitty terminal.

[Nerd Fonts](https://www.nerdfonts.com/)
[Nerd Fonts](https://www.nerdfonts.com/)


## Command line tools

- ripgrep text search tool
- fzf fuzzy finder
- gdu
- fzf fuzzy finder
- gdu
- btm from [:fontawesome-brands-github: GitHub repository releases](https://github.com/ClementTsang/bottom/releases/)

=== "Debian packages"
Expand All @@ -43,6 +43,4 @@ Install btm from its [:fontawesome-brands-github: GitHub repository release page

AstroNvim uses Mason to install LSP servers, format and lint tools. Many LSP servers require node.js to install and function.

[Node.js install - Practicalli Engineering Playbook](https://practical.li/engineering-playbook/programming-languages/javascript/nodejs/){target=_blank .md-button}


[Node.js install - Practicalli Engineering Playbook](https://practical.li/engineering-playbook/programming-languages/javascript/nodejs/){target=_blank .md-button}
10 changes: 5 additions & 5 deletions docs/introduction/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ A clean UI provides for a distraction free development experience, with only the

* [Conjure](#conjure) - automatic Clojure REPL connection, evaluation, test runners
* Treesitter
* Plug-in Manager (e.g. Lazy.nvim)
* Plug-in Manager (e.g. Lazy.nvim)
* [LSP](#language-server-protocol) - auto-completion, snippets, inline linting, reference navigation, refactor and unit test coverage
* [statusline](#status-line) - LSP status, diff changes, filetype, cursor position
* [Selection narrowing](#selection-narrowing) completion of files, packages, colour schemes, etc
Expand All @@ -41,7 +41,7 @@ Run unit tests with Kaocha test runner (Cognitect Labs and ClojureScript runners

## Lazy Plugin manager

Lazy.nvim manages neovim plugins with a rich UI that provides an enjoyable user experience. Plugins are automatically installed during startup and lists the status of each plugins.
Lazy.nvim manages neovim plugins with a rich UI that provides an enjoyable user experience. Plugins are automatically installed during startup and lists the status of each plugins.

Plugins are automatic cached & bytecode compiled and can be lazy loaded to streamline startup time and resource usage based on events, commands, filetypes, and key mappings. Efficient plugin downlaods using partial blobless clones of plugin repositories, i.e. `--filter=blob:none`

Expand All @@ -53,12 +53,12 @@ Plugins are automatic cached & bytecode compiled and can be lazy loaded to strea

Neovim provides highly effective syntax highlighting of source code due to Treesitter.

Tree-sitter parses files opened in Neovim and builds a concrete syntax tree that any Neovim plugin can use to efficiently provide feedback. Treesitter uses incremental parsing to efficiently update the syntax tree as a file is edited.
Tree-sitter parses files opened in Neovim and builds a concrete syntax tree that any Neovim plugin can use to efficiently provide feedback. Treesitter uses incremental parsing to efficiently update the syntax tree as a file is edited.

- parse on every keystroke in a text editor
- provide useful results even in the presence of syntax errors

[:globe_with_meridians: Treesitter](https://tree-sitter.github.io/tree-sitter/){target=_blank .md-button}
[:globe_with_meridians: Treesitter](https://tree-sitter.github.io/tree-sitter/){target=_blank .md-button}


## Language Server Protocol
Expand Down Expand Up @@ -102,7 +102,7 @@ null-ls provides extensive builtin configuration for programming languages and c

[:fontawesome-brands-github: telescope.nvim](https://github.com/nvim-telescope/telescope.nvim){target=_blank} is a highly extendable fuzzy finder over lists with community driven pickers, sorters and previewers.

Navigate and narrow lists of files, packages, environment variables, ports, colour schemes (themes) and any other list of items effectively.
Navigate and narrow lists of files, packages, environment variables, ports, colour schemes (themes) and any other list of items effectively.

Telescope File browser popup also explores the file system and in Normal mode can be used to create files and directories

Expand Down
Loading

0 comments on commit 0ea32cd

Please sign in to comment.