diff --git a/docs/configuration/astronvim/index.md b/docs/configuration/astronvim/index.md deleted file mode 100644 index 685b1d0b..00000000 --- a/docs/configuration/astronvim/index.md +++ /dev/null @@ -1,28 +0,0 @@ -# Config Design - AstroNvim - -[:globe_with_meridians: AstroNvim](https://astronvim.com/) is a community configuration with an engaging UI, using Lazy for plugin management (Neovim packages) and Mason for package management (LSP, DAP, format and lint tools) - -[:fontawesome-brands-github: Practicalli AstroNvim User Config](https://github.com/practicalli/astro) is a user configuration that extends AstroNvim and imports packages from the [:fontawesome-brands-github: AstroNvim Community](https://github.com/AstroNvim/user_example). - - -## Neovim Configuration - -Practicalli Neovim is based on [AstroNvim](astronvim/), a thoughtful configuration that supports the latest Neovim stable releases, provides a polished UI and many community extensions. - -Practicalli AstroNvim User Config provides a complete Clojure config on top of AstroNvim. - -[Install Practicalli AstroNvim Config](astronvim/index.md){.md-button} - - -> NOTE: [Practicalli Neovim Config Redux](practicalli/) was a learning experiment that provided mnemonic key bindings, packer, telescope selector, written in Fennel. This project has now been archived in favour of AstroNvim - - - - - - -### Configure format rules - -The configuration files for each lint and format tool should be used by Neovim. - -> Setting a different location for these files has proved challenging. `plugin/null-ls.lua` has a section to override its builtin configuration for each lint and format tool, however, in tests Practicalli was unable to succeffuly set a different location. diff --git a/docs/configuration/astronvim/astrocommunity.md b/docs/reference/configuration/astrocommunity.md similarity index 100% rename from docs/configuration/astronvim/astrocommunity.md rename to docs/reference/configuration/astrocommunity.md diff --git a/docs/configuration/astronvim/config-design.md b/docs/reference/configuration/index.md similarity index 90% rename from docs/configuration/astronvim/config-design.md rename to docs/reference/configuration/index.md index 5d4f3629..3a30e9cf 100644 --- a/docs/configuration/astronvim/config-design.md +++ b/docs/reference/configuration/index.md @@ -1,10 +1,12 @@ -# 📦 Practicalli AstroNvim Config Design +# 📦 Practicalli Astro Config Design A guide to the design of AstroNvim Config created by Practicalli to support a comprehensive development workflow. ??? INFO "AstroCommunity Plugin Configurations used where available" Plugin configurations from AstroCommunity are used to minimise the code size and maintenance of the Practicalli configuration +!!! WARNING "Under review after migration to AstroNvim 4" + ## Files overview @@ -34,11 +36,12 @@ The file structure as taken from the AstroNvim template and new files were creat - :octicons-file-16: :material-close-circle-outline: `neo-tree.lua` visual file navigator - example config - :octicons-file-16: :material-close-circle-outline: `none-ls.lua` example config for format & lint tools - :octicons-file-added-16: :material-close-circle-outline: `platuml.lua` UML diagrams defined with code - requires plantuml.com install -- :octicons-file-added-16: `practicalli.lua` theme, dashboard & key binding preferences enjoyed by Practicalli - :octicons-file-added-16: `snippets.lua` load JSON style snippet definitions - :octicons-file-added-16:`telescope.lua` ensure Treesitter languages are installed (AstroCommunity language packs also ensure parsers installed) - :octicons-file-16: :material-close-circle-outline: `treesittter.lua` ensure Treesitter languages are installed (AstroCommunity language packs also ensure parsers installed) -- :octicons-file-16: :material-close-circle-outline: `user.lua` example user configuration, added via `lua/plugins/practicalli.lua` +- :octicons-file-16: :material-close-circle-outline: `user.lua` example user configuration, added via `lua/plugins/user-practicalli.lua` +- :octicons-file-added-16: `user-practicalli.lua` theme, dashboard & key binding preferences enjoyed by Practicalli +- :octicons-file-added-16: `user-termux.lua` mason lsp server overrides, pinned plugin versions for neovim 0.9.x ## Clojure support @@ -446,6 +449,64 @@ else ``` + + + +