Compare commits
No commits in common. "a0a3109f5a7ab3e8616c72bb8bd667c5a1b6ee8c" and "059adb459eb32cae7d4dae0f5d18a10655ec476e" have entirely different histories.
a0a3109f5a
...
059adb459e
5 changed files with 159 additions and 7 deletions
35
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
35
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,35 @@
|
||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Create a report to help us improve
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<!-- Any bug report not following this template will be immediately closed. Thanks -->
|
||||||
|
|
||||||
|
## Before Reporting an Issue
|
||||||
|
- I have read the kickstart.nvim README.md.
|
||||||
|
- I have read the appropriate plugin's documentation.
|
||||||
|
- I have searched that this issue has not been reported before.
|
||||||
|
|
||||||
|
- [ ] **By checking this, I confirm that the above steps are completed. I understand leaving this unchecked will result in this report being closed immediately.**
|
||||||
|
|
||||||
|
## Describe the bug
|
||||||
|
<!-- A clear and concise description of what the bug is. -->
|
||||||
|
|
||||||
|
## To Reproduce
|
||||||
|
<!-- Steps to reproduce the behavior. -->
|
||||||
|
1. ...
|
||||||
|
|
||||||
|
## Desktop
|
||||||
|
<!-- please complete the following information. -->
|
||||||
|
- OS:
|
||||||
|
- Terminal:
|
||||||
|
|
||||||
|
## Neovim Version
|
||||||
|
<!-- Output of running `:version` from inside of neovim. -->
|
||||||
|
|
||||||
|
```
|
||||||
|
```
|
||||||
8
.github/pull_request_template.md
vendored
Normal file
8
.github/pull_request_template.md
vendored
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
***************************************************************************
|
||||||
|
**NOTE**
|
||||||
|
Please verify that the `base repository` above has the intended destination!
|
||||||
|
Github by default opens Pull Requests against the parent of a forked repository.
|
||||||
|
If this is your personal fork and you didn't intend to open a PR for contribution
|
||||||
|
to the original project then adjust the `base repository` accordingly.
|
||||||
|
**************************************************************************
|
||||||
|
|
||||||
21
.github/workflows/stylua.yml
vendored
Normal file
21
.github/workflows/stylua.yml
vendored
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
# Check Lua Formatting
|
||||||
|
name: Check Lua Formatting
|
||||||
|
on: pull_request_target
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
stylua-check:
|
||||||
|
if: github.repository == 'nvim-lua/kickstart.nvim'
|
||||||
|
name: Stylua Check
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout Code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
ref: ${{ github.event.pull_request.head.sha }}
|
||||||
|
- name: Stylua Check
|
||||||
|
uses: JohnnyMorganz/stylua-action@v3
|
||||||
|
with:
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
version: latest
|
||||||
|
args: --check .
|
||||||
|
|
||||||
3
doc/tags
Normal file
3
doc/tags
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
kickstart-is kickstart.txt /*kickstart-is*
|
||||||
|
kickstart-is-not kickstart.txt /*kickstart-is-not*
|
||||||
|
kickstart.nvim kickstart.txt /*kickstart.nvim*
|
||||||
99
init.lua
99
init.lua
|
|
@ -1,3 +1,89 @@
|
||||||
|
--[[
|
||||||
|
|
||||||
|
=====================================================================
|
||||||
|
==================== READ THIS BEFORE CONTINUING ====================
|
||||||
|
=====================================================================
|
||||||
|
======== .-----. ========
|
||||||
|
======== .----------------------. | === | ========
|
||||||
|
======== |.-""""""""""""""""""-.| |-----| ========
|
||||||
|
======== || || | === | ========
|
||||||
|
======== || KICKSTART.NVIM || |-----| ========
|
||||||
|
======== || || | === | ========
|
||||||
|
======== || || |-----| ========
|
||||||
|
======== ||:Tutor || |:::::| ========
|
||||||
|
======== |'-..................-'| |____o| ========
|
||||||
|
======== `"")----------------(""` ___________ ========
|
||||||
|
======== /::::::::::| |::::::::::\ \ no mouse \ ========
|
||||||
|
======== /:::========| |==hjkl==:::\ \ required \ ========
|
||||||
|
======== '""""""""""""' '""""""""""""' '""""""""""' ========
|
||||||
|
======== ========
|
||||||
|
=====================================================================
|
||||||
|
=====================================================================
|
||||||
|
|
||||||
|
What is Kickstart?
|
||||||
|
|
||||||
|
Kickstart.nvim is *not* a distribution.
|
||||||
|
|
||||||
|
Kickstart.nvim is a starting point for your own configuration.
|
||||||
|
The goal is that you can read every line of code, top-to-bottom, understand
|
||||||
|
what your configuration is doing, and modify it to suit your needs.
|
||||||
|
|
||||||
|
Once you've done that, you can start exploring, configuring and tinkering to
|
||||||
|
make Neovim your own! That might mean leaving Kickstart just the way it is for a while
|
||||||
|
or immediately breaking it into modular pieces. It's up to you!
|
||||||
|
|
||||||
|
If you don't know anything about Lua, I recommend taking some time to read through
|
||||||
|
a guide. One possible example which will only take 10-15 minutes:
|
||||||
|
- https://learnxinyminutes.com/docs/lua/
|
||||||
|
|
||||||
|
After understanding a bit more about Lua, you can use `:help lua-guide` as a
|
||||||
|
reference for how Neovim integrates Lua.
|
||||||
|
- :help lua-guide
|
||||||
|
- (or HTML version): https://neovim.io/doc/user/lua-guide.html
|
||||||
|
|
||||||
|
Kickstart Guide:
|
||||||
|
|
||||||
|
TODO: The very first thing you should do is to run the command `:Tutor` in Neovim.
|
||||||
|
|
||||||
|
If you don't know what this means, type the following:
|
||||||
|
- <escape key>
|
||||||
|
- :
|
||||||
|
- Tutor
|
||||||
|
- <enter key>
|
||||||
|
|
||||||
|
(If you already know the Neovim basics, you can skip this step.)
|
||||||
|
|
||||||
|
Once you've completed that, you can continue working through **AND READING** the rest
|
||||||
|
of the kickstart init.lua.
|
||||||
|
|
||||||
|
Next, run AND READ `:help`.
|
||||||
|
This will open up a help window with some basic information
|
||||||
|
about reading, navigating and searching the builtin help documentation.
|
||||||
|
|
||||||
|
This should be the first place you go to look when you're stuck or confused
|
||||||
|
with something. It's one of my favorite Neovim features.
|
||||||
|
|
||||||
|
MOST IMPORTANTLY, we provide a keymap "<space>sh" to [s]earch the [h]elp documentation,
|
||||||
|
which is very useful when you're not exactly sure of what you're looking for.
|
||||||
|
|
||||||
|
I have left several `:help X` comments throughout the init.lua
|
||||||
|
These are hints about where to find more information about the relevant settings,
|
||||||
|
plugins or Neovim features used in Kickstart.
|
||||||
|
|
||||||
|
NOTE: Look for lines like this
|
||||||
|
|
||||||
|
Throughout the file. These are for you, the reader, to help you understand what is happening.
|
||||||
|
Feel free to delete them once you know what you're doing, but they should serve as a guide
|
||||||
|
for when you are first encountering a few different constructs in your Neovim config.
|
||||||
|
|
||||||
|
If you experience any errors while trying to install kickstart, run `:checkhealth` for more info.
|
||||||
|
|
||||||
|
I hope you enjoy your Neovim journey,
|
||||||
|
- TJ
|
||||||
|
|
||||||
|
P.S. You can delete this when you're done too. It's your config now! :)
|
||||||
|
--]]
|
||||||
|
|
||||||
-- Set <space> as the leader key
|
-- Set <space> as the leader key
|
||||||
-- See `:help mapleader`
|
-- See `:help mapleader`
|
||||||
-- NOTE: Must happen before plugins are loaded (otherwise wrong leader will be used)
|
-- NOTE: Must happen before plugins are loaded (otherwise wrong leader will be used)
|
||||||
|
|
@ -787,8 +873,7 @@ require('lazy').setup({
|
||||||
-- the rust implementation via `'prefer_rust_with_warning'`
|
-- the rust implementation via `'prefer_rust_with_warning'`
|
||||||
--
|
--
|
||||||
-- See :h blink-cmp-config-fuzzy for more information
|
-- See :h blink-cmp-config-fuzzy for more information
|
||||||
-- fuzzy = { implementation = 'lua' },
|
fuzzy = { implementation = 'lua' },
|
||||||
fuzzy = { implementation = 'prefer_rust_with_warning' },
|
|
||||||
|
|
||||||
-- Shows a signature help window while you type arguments for a function
|
-- Shows a signature help window while you type arguments for a function
|
||||||
signature = { enabled = true },
|
signature = { enabled = true },
|
||||||
|
|
@ -893,11 +978,11 @@ require('lazy').setup({
|
||||||
-- Uncomment any of the lines below to enable them (you will need to restart nvim).
|
-- Uncomment any of the lines below to enable them (you will need to restart nvim).
|
||||||
--
|
--
|
||||||
-- require 'kickstart.plugins.debug',
|
-- require 'kickstart.plugins.debug',
|
||||||
require 'kickstart.plugins.indent_line',
|
-- require 'kickstart.plugins.indent_line',
|
||||||
require 'kickstart.plugins.lint',
|
-- require 'kickstart.plugins.lint',
|
||||||
require 'kickstart.plugins.autopairs',
|
-- require 'kickstart.plugins.autopairs',
|
||||||
require 'kickstart.plugins.neo-tree',
|
-- require 'kickstart.plugins.neo-tree',
|
||||||
require 'kickstart.plugins.gitsigns', -- adds gitsigns recommend keymaps
|
-- require 'kickstart.plugins.gitsigns', -- adds gitsigns recommend keymaps
|
||||||
|
|
||||||
-- NOTE: The import below can automatically add your own plugins, configuration, etc from `lua/custom/plugins/*.lua`
|
-- NOTE: The import below can automatically add your own plugins, configuration, etc from `lua/custom/plugins/*.lua`
|
||||||
-- This is the easiest way to modularize your config.
|
-- This is the easiest way to modularize your config.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue