Skip to content

Commit 4c4096c

Browse files
committed
init: kickstart.nvim
0 parents  commit 4c4096c

File tree

6 files changed

+475
-0
lines changed

6 files changed

+475
-0
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
tags

.stylua.toml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
column_width = 160
2+
line_endings = "Unix"
3+
indent_type = "Spaces"
4+
indent_width = 2
5+
quote_style = "AutoPreferSingle"
6+
no_call_parentheses = true

Dockerfile

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Build neovim separately in the first stage
2+
FROM alpine:latest AS base
3+
4+
RUN apk --no-cache add \
5+
autoconf \
6+
automake \
7+
build-base \
8+
cmake \
9+
ninja \
10+
coreutils \
11+
curl \
12+
gettext-tiny-dev \
13+
git \
14+
libtool \
15+
pkgconf \
16+
unzip
17+
18+
# Build neovim (and use it as an example codebase
19+
RUN git clone https://github.com/neovim/neovim.git
20+
21+
ARG VERSION=master
22+
RUN cd neovim && git checkout ${VERSION} && make CMAKE_BUILD_TYPE=RelWithDebInfo install
23+
24+
# To support kickstart.nvim
25+
RUN apk --no-cache add \
26+
fd \
27+
ctags \
28+
ripgrep \
29+
git
30+
31+
# Copy the kickstart.nvim init.lua
32+
COPY ./init.lua /root/.config/nvim/init.lua
33+
34+
WORKDIR /neovim

LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 Michael Lingelbach
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
### Introduction
2+
3+
A starting point for neovim that is:
4+
5+
* Small (~325 lines)
6+
* Single-file
7+
* Documented
8+
* Modular
9+
10+
Kickstart targets *only* the latest stable neovim release (0.7) and the nightly.
11+
12+
This repo is meant to be used as a starting point for a user's own configuration; remove the things you don't use and add what you miss. This configuration serves as the reference configuration for the [lspconfig wiki](https://github.com/neovim/nvim-lspconfig/wiki).
13+
14+
See the [wiki](https://github.com/nvim-lua/kickstart.nvim/wiki) for additional tips, tricks, and recommended plugins.
15+
16+
### Installation
17+
* Backup your previous configuration
18+
* Copy and paste the kickstart.nvim `init.lua` into `$HOME/.config/nvim/init.lua`
19+
* start neovim (`nvim`) and run `:PackerInstall`, ignore any error message about missing plugins, `:PackerInstall` will fix that shortly.
20+
* restart neovim
21+
22+
### Contribution
23+
24+
Pull-requests are welcome. The goal of this repo is not to create a neovim configuration framework, but to offer a starting template that shows, by example, available features in neovim. Some things that will not be included:
25+
26+
* Custom language server configuration (null-ls templates)
27+
* Theming beyond a default colorscheme necessary for LSP highlight groups
28+
* Lazy-loading. Kickstart.nvim should start within 40 ms on modern hardware. Please profile and contribute to upstream plugins to optimize startup time instead.
29+
30+
Each PR, especially those which increase the line count, should have a description as to why the PR is necessary.

0 commit comments

Comments
 (0)