Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/javiorfo/nvim-soil
Neovim plugin written in Lua for Plant UML
https://github.com/javiorfo/nvim-soil
neovim neovim-plugin plantuml uml
Last synced: about 2 months ago
JSON representation
Neovim plugin written in Lua for Plant UML
- Host: GitHub
- URL: https://github.com/javiorfo/nvim-soil
- Owner: javiorfo
- License: other
- Created: 2023-02-02T02:22:02.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-14T02:20:24.000Z (5 months ago)
- Last Synced: 2024-08-14T03:58:00.919Z (5 months ago)
- Topics: neovim, neovim-plugin, plantuml, uml
- Language: Lua
- Homepage:
- Size: 91.8 KB
- Stars: 46
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nvim-soil
### Soil for a plant (UML)
*nvim-soil is a minimal plugin written in Lua for Plant UML.*
## Caveats
- `Java` and `nsxiv` (default but editable) are required to be installed in order to use this plugin.
- `plantuml` is optional to be installed or used in jar format.
- Recommended for Plant UML syntax highlighting [nvim-nyctophilia colorscheme](https://github.com/javiorfo/nvim-nyctophilia)
- This plugin has been developed on and for Linux following open source philosophy.
## Installation
`Packer`
```lua
use 'javiorfo/nvim-soil'
-- Optional for puml syntax highlighting:
use 'javiorfo/nvim-nyctophilia'
```
`Lazy`
```lua
{
'javiorfo/nvim-soil',
-- Optional for puml syntax highlighting:
dependencies = { 'javiorfo/nvim-nyctophilia' },
lazy = true,
ft = "plantuml",
opts = {
-- If you want to change default configurations
-- This option closes the image viewer and reopen the image generated
-- When true this offers some kind of online updating (like plantuml web server)
actions = {
redraw = false
}
-- If you want to use Plant UML jar version instead of the installed version
puml_jar = "/path/to/plantuml.jar",
-- If you want to customize the image showed when running this plugin
image = {
darkmode = false, -- Enable or disable darkmode
format = "png", -- Choose between png or svg
-- This is a default implementation of using nsxiv to open the resultant image
-- Edit the string to use your preferred app to open the image (as if it were a command line)
-- Some examples:
-- return "feh " .. img
-- return "xdg-open " .. img
execute_to_open = function(img)
return "nsxiv -b " .. img
end
}
}
}
```
## Configuration
#### Defaults
- If `plantuml` is installed you don't need any extra set up. But if wanted to use **plantuml jar version** you can set it up.
- The default image format is **PNG**.
- The default action redraw format is **false**.
- The default Plant UML **darkmode** is set to **false**.
## Usage
- Open any yourfile.plantuml, yourfile.pu or yourfile.puml which you want to process and use `:Soil` Neovim command line to generate and open yourfile.png with graphical output. Press `q` to quit the image viewer.
- Everytime you update a Plant UML file and run `:Soil`, you'll get an updated image.
- The generated image is saved in the same location that your Plant UML file.
- To open the generated image without run Plant UML again use `:SoilOpenImg` command.
## Screenshots
### Simple use
**NOTE:** The colorscheme **nox** from [nvim-nyctophilia](https://github.com/javiorfo/nvim-nyctophilia) is used in this image.
---
### Donate
- **Bitcoin** [(QR)](https://raw.githubusercontent.com/javiorfo/img/master/crypto/bitcoin.png) `1GqdJ63RDPE4eJKujHi166FAyigvHu5R7v`
- [Paypal](https://www.paypal.com/donate/?hosted_button_id=FA7SGLSCT2H8G)