From 605a010655ccfa9449d436ffe76258660778465c Mon Sep 17 00:00:00 2001 From: max397574 Date: Fri, 17 Dec 2021 12:27:25 +0100 Subject: docs(readme): removed unnecessary code --- readme.md | 72 ++++++++++++++++++++++++++++----------------------------------- 1 file changed, 32 insertions(+), 40 deletions(-) diff --git a/readme.md b/readme.md index 793a92f..fd4fec1 100644 --- a/readme.md +++ b/readme.md @@ -37,45 +37,37 @@ use { Call the setup function with your configurations. ```lua --- lua and packer.nvim - -use { - "startup-nvim/startup.nvim", - requires = {"nvim-telescope/telescope.nvim", "nvim-lua/plenary.nvim"}, - config = function() - require"startup".setup({ - section_1 =
-- for the structure of a section see below - section_2 =
-- as much sections as you like - options = { - mapping_keys = true, -- display mapping (e.g. ff) - - -- if < 0 fraction of screen width - -- if > 0 numbers of column - cursor_column = 0.5 - - after = function() -- function that gets executed at the end - - end - empty_lines_between_mappings = true, -- add an empty line between mapping/commands - disable_statuslines = true -- disable status-, buffer- and tablines - paddings = {1,2}, -- amount of empty lines before each section (must be equal to amount of sections) - } - mappings = { - execute_command = "", - open_file = "o", - open_file_split = "", - open_section = "", - open_help = "?", - }, - colors = { - background = "#1f2227", - folded_section = "#56b6c2", -- the color of folded sections - -- this can also be changed with the `StartupFoldedSection` highlight group - } - parts = {"section_1", "section_2"} -- all sections in order - }) - end -} +require"startup".setup({ + section_1 =
-- for the structure of a section see below + section_2 =
-- as much sections as you like + options = { + mapping_keys = true, -- display mapping (e.g. ff) + + -- if < 0 fraction of screen width + -- if > 0 numbers of column + cursor_column = 0.5 + + after = function() -- function that gets executed at the end + + end + empty_lines_between_mappings = true, -- add an empty line between mapping/commands + disable_statuslines = true -- disable status-, buffer- and tablines + paddings = {1,2}, -- amount of empty lines before each section (must be equal to amount of sections) + } + mappings = { + execute_command = "", + open_file = "o", + open_file_split = "", + open_section = "", + open_help = "?", + }, + colors = { + background = "#1f2227", + folded_section = "#56b6c2", -- the color of folded sections + -- this can also be changed with the `StartupFoldedSection` highlight group + } + parts = {"section_1", "section_2"} -- all sections in order +}) ``` You could also put the configurations into a file. @@ -273,7 +265,7 @@ They are documented in `:help startup_nvim.functions`. The same applies to headers. Here you can use them with `require("startup.headers").header_name()`. They are documented in `:help startup_nvim.headers`. -A good tool to create your own headers is [image to braille](https://505e06b2.github.io/Image-to-Braille/) +A good tool to create your own headers is [image to braille](https://505e06b2.github.io/Image-to-Braille/). 👀 Screenshots -------------- -- cgit v1.2.3