https://github.com/cih2001/pikchr.nvim

Render Pikchr diagram in neovim
https://github.com/cih2001/pikchr.nvim

lua neovim neovim-plugin pikchr vim

Last synced: 10 months ago
JSON representation

Render Pikchr diagram in neovim

• Host: GitHub
• URL: https://github.com/cih2001/pikchr.nvim
• Owner: Cih2001
• Created: 2025-06-08T18:56:58.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-06-08T19:17:29.000Z (10 months ago)
• Last Synced: 2025-06-08T20:26:20.932Z (10 months ago)
• Topics: lua, neovim, neovim-plugin, pikchr, vim
• Language: HTML
• Homepage:
• Size: 362 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# 🖼️ pikchr.nvim

**Live-render [Pikchr](https://pikchr.org/) (pronounced "picture") diagrams in your browser, directly from Neovim.**

`pikchr.nvim` is a Neovim plugin that watches `.pikchr` files and renders them as SVG in your browser using WebAssembly. Every time you save or edit your file, the diagram is automatically updated in real-time.

![demo](./doc/images/demo.gif)

## ✨ Features

- Live preview of `.pikchr` diagrams in your browser

- Automatic reload on file changes

- Uses WebAssembly for fast client-side SVG rendering

- Zero external dependencies beyond a modern browser

---

## 🚀 Installation

Using [lazy.nvim](https://github.com/folke/lazy.nvim):

```lua

{

    "Cih2001/pikchr.nvim",

    lazy = false, -- or set true for lazy loading

    cmd = "Pikchr",

    config = function()

        require("pikchr").setup({

            server_port = 1234,

        })

    end,

},

```

## Usage

- To start the local server run `:Pikchr start` and navigate to "http://localhost:1234"

- To stop the local server run `:Pikchr stop`