From 75b6eede2fd96de61144fee91c8e300da1cc5dbf Mon Sep 17 00:00:00 2001
From: adollar <71227493+abp1994@users.noreply.github.com>
Date: Sun, 29 Jun 2025 21:31:28 +0100
Subject: [PATCH] added md renderer
---
README.md | 65 +++++++++++++++++++--------------
init.lua | 1 +
lazy-lock.json | 1 +
lua/plugins/render-markdown.lua | 9 +++++
4 files changed, 48 insertions(+), 28 deletions(-)
create mode 100644 lua/plugins/render-markdown.lua
diff --git a/README.md b/README.md
index 41139505..eefbb899 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,9 @@
A starting point for Neovim that is:
-* Small
-* Single-file
-* Completely Documented
+- Small
+- Single-file
+- Completely Documented
**NOT** a Neovim distribution, but instead a starting point for your configuration.
@@ -14,7 +14,7 @@ A starting point for Neovim that is:
### Install Neovim
-Kickstart.nvim targets *only* the latest
+Kickstart.nvim targets _only_ the latest
['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest
['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim.
If you are experiencing issues, please make sure you have the latest versions.
@@ -22,6 +22,7 @@ If you are experiencing issues, please make sure you have the latest versions.
### Install External Dependencies
External Requirements:
+
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation),
[fd-find](https://github.com/sharkdp/fd#installation)
@@ -45,11 +46,11 @@ External Requirements:
Neovim's configurations are located under the following paths, depending on your OS:
-| OS | PATH |
-| :- | :--- |
-| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
-| Windows (cmd)| `%localappdata%\nvim\` |
-| Windows (powershell)| `$env:LOCALAPPDATA\nvim\` |
+| OS | PATH |
+| :------------------- | :---------------------------------------- |
+| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
+| Windows (cmd) | `%localappdata%\nvim\` |
+| Windows (powershell) | `$env:LOCALAPPDATA\nvim\` |
#### Recommended Step
@@ -115,19 +116,18 @@ examples of adding popularly requested plugins.
> [!NOTE]
> For more information about a particular plugin check its repository's documentation.
-
-### Getting Started
+### Getting Startedplugins out there, however most rely on a browser window to get the preview. This is definitely the correct thing to do to get all the features out of Markdown but I wanted something to
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
### FAQ
-* What should I do if I already have a pre-existing Neovim configuration?
- * You should back it up and then delete all associated files.
- * This includes your existing init.lua and the Neovim files in `~/.local`
+- What should I do if I already have a pre-existing Neovim configuration?
+ - You should back it up and then delete all associated files.
+ - This includes your existing init.lua and the Neovim files in `~/.local`
which can be deleted with `rm -rf ~/.local/share/nvim/`
-* Can I keep my existing configuration in parallel to kickstart?
- * Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME`
+- Can I keep my existing configuration in parallel to kickstart?
+ - Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME`
to maintain multiple configurations. For example, you can install the kickstart
configuration in `~/.config/nvim-kickstart` and create an alias:
```
@@ -137,18 +137,18 @@ examples of adding popularly requested plugins.
config directory and the matching local directory
`~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim
distribution that you would like to try out.
-* What if I want to "uninstall" this configuration:
- * See [lazy.nvim uninstall](https://lazy.folke.io/usage#-uninstalling) information
-* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
- * The main purpose of kickstart is to serve as a teaching tool and a reference
+- What if I want to "uninstall" this configuration:
+ - See [lazy.nvim uninstall](https://lazy.folke.io/usage#-uninstalling) information
+- Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
+ - The main purpose of kickstart is to serve as a teaching tool and a reference
configuration that someone can easily use to `git clone` as a basis for their own.
As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
into smaller parts. A fork of kickstart that does this while maintaining the
same functionality is available here:
- * [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
- * Discussions on this topic can be found here:
- * [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)
- * [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)
+ - [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
+ - Discussions on this topic can be found here:
+ - [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)
+ - [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)
### Install Recipes
@@ -170,23 +170,27 @@ This requires:
```lua
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
```
+
Windows with gcc/make using chocolatey
Alternatively, one can install gcc and make which don't require changing the config,
the easiest way is to use choco:
1. install [chocolatey](https://chocolatey.org/install)
-either follow the instructions on the page or use winget,
-run in cmd as **admin**:
+ either follow the instructions on the page or use winget,
+ run in cmd as **admin**:
+
```
winget install --accept-source-agreements chocolatey.chocolatey
```
2. install all requirements using choco, exit the previous cmd and
-open a new one so that choco path is set, and run in cmd as **admin**:
+ open a new one so that choco path is set, and run in cmd as **admin**:
+
```
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
```
+
WSL (Windows Subsystem for Linux)
@@ -197,9 +201,11 @@ sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim
```
+
Ubuntu Install Steps
```
@@ -207,6 +213,7 @@ sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim
```
+
Debian Install Steps
@@ -224,12 +231,14 @@ sudo tar -C /opt -xzf nvim-linux-x86_64.tar.gz
# make it available in /usr/local/bin, distro installs to /usr/bin
sudo ln -sf /opt/nvim-linux-x86_64/bin/nvim /usr/local/bin/
```
+
Fedora Install Steps
```
sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
```
+
Arch Install Steps
@@ -237,5 +246,5 @@ sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
```
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
```
-