KaitlynEthylia/pingo

A lightweight and extensible neovim plugin for pinning code snippets to windows.

Warning This project is under development and not ready for general use. This plugin is meant to serve as an improved replacement for TreePin, so use that in the meantime.

Pingo

Table of Contents

• Introduction
• Requirements
• Installation
  • Lazy.nvim
  • Packer
  • Plug
• Demo
• Setup
  • Default Config
• Commands
• Extensions
• Contributing

Introduction

Requirements

• Neovim >= TBD
• telescope.nvim (Only when using the Telescope extension, naturally)
• nvim-treesitter (Only when using the Traverse and Context extensions)
• [nvim-treesitter-context](https://github.com/nvim-treesitter/ nvim-treesitter-context) (Only when using the Context exentension)

Installation

Note This assumes you're not using any of the extensions. If you are, see Extensions.

Lazy.nvim

return {
	'KaitlynEthylia/pingo',
	init = function() require('treepin').setup() end,
}

Packer

Plug

Demo

Setup

Default Config

require('pingo').setup {
	hide_on_screen = true,
	off_buffer = 'hide',
	seperator = nil,
	icon = '>',
	end_icon = nil,
	max_height = 30,
	zindex = 50,
	position = 'relative',
	live_update = false,
	add_new_lines = false,
	traverse = nil,
	telescope = nil,
	context = nil,
}

My personal configuration

require('pingo').setup {
	off_buffer = 'show',
	icon = '',
	add_new_lines = true,
	traverse = {}, -- Not yet done
	telescope = {}, -- Not yet done
	context = {}, -- Not yet done
}

Commands

Extensions

Context

Telescope

Traverse

Contributing