{"id":22006320,"url":"https://github.com/javiorfo/nvim-soil","last_synced_at":"2025-05-05T21:49:09.395Z","repository":{"id":71130117,"uuid":"596360738","full_name":"javiorfo/nvim-soil","owner":"javiorfo","description":"Neovim plugin written in Lua for Plant UML","archived":false,"fork":false,"pushed_at":"2024-08-14T02:20:24.000Z","size":94,"stargazers_count":46,"open_issues_count":0,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-14T03:58:00.919Z","etag":null,"topics":["neovim","neovim-plugin","plantuml","uml"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/javiorfo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-02T02:22:02.000Z","updated_at":"2024-08-14T02:20:27.000Z","dependencies_parsed_at":"2023-07-09T18:00:19.676Z","dependency_job_id":"cb24b1aa-2bcb-4ba7-bf96-a1c975676df9","html_url":"https://github.com/javiorfo/nvim-soil","commit_stats":null,"previous_names":["charkuils/nvim-soil","javiorfo/nvim-soil","caosystema/nvim-soil","progrimorio/nvim-soil","orfosys/nvim-soil","chaosystema/nvim-soil"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javiorfo%2Fnvim-soil","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javiorfo%2Fnvim-soil/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javiorfo%2Fnvim-soil/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javiorfo%2Fnvim-soil/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/javiorfo","download_url":"https://codeload.github.com/javiorfo/nvim-soil/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252583067,"owners_count":21771782,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["neovim","neovim-plugin","plantuml","uml"],"created_at":"2024-11-30T01:11:37.343Z","updated_at":"2025-05-05T21:49:09.388Z","avatar_url":"https://github.com/javiorfo.png","language":"Lua","funding_links":["https://www.paypal.com/donate/?hosted_button_id=FA7SGLSCT2H8G"],"categories":["Lua"],"sub_categories":[],"readme":"# nvim-soil\n### Soil for a plant (UML)\n*nvim-soil is a minimal plugin written in Lua for Plant UML.*\n\n## Caveats\n- `Java` and `nsxiv` (default but editable) are required to be installed in order to use this plugin.\n- `plantuml` is optional to be installed or used in jar format.\n- Recommended for Plant UML syntax highlighting [nvim-nyctophilia colorscheme](https://github.com/javiorfo/nvim-nyctophilia)\n- This plugin has been developed on and for Linux following open source philosophy.\n\n## Installation\n`Packer`\n```lua\nuse 'javiorfo/nvim-soil'\n\n-- Optional for puml syntax highlighting:\nuse 'javiorfo/nvim-nyctophilia'\n```\n`Lazy`\n```lua\n{ \n    'javiorfo/nvim-soil',\n\n    -- Optional for puml syntax highlighting:\n    dependencies = { 'javiorfo/nvim-nyctophilia' },\n\n    lazy = true,\n    ft = \"plantuml\",\n    opts = {\n        -- If you want to change default configurations\n\n        -- This option closes the image viewer and reopen the image generated\n        -- When true this offers some kind of online updating (like plantuml web server)\n        actions = {\n            redraw = false \n        },\n\n        -- If you want to use Plant UML jar version instead of the installed version\n        puml_jar = \"/path/to/plantuml.jar\",\n        \n        -- If you want to customize the image showed when running this plugin\n        image = {\n            darkmode = false, -- Enable or disable darkmode\n            format = \"png\", -- Choose between png or svg\n    \n            -- This is a default implementation of using nsxiv to open the resultant image\n            -- Edit the string to use your preferred app to open the image (as if it were a command line)\n            -- Some examples:\n            -- return \"feh \" .. img\n            -- return \"xdg-open \" .. img\n            execute_to_open = function(img) \n                return \"nsxiv -b \" .. img\n            end\n        }\n    }\n}\n```\n\n## Configuration\n#### Defaults\n- 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.\n- The default image format is **PNG**. \n- The default action redraw format is **false**. \n- The default Plant UML **darkmode** is set to **false**. \n\n## Usage\n- 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.\n- Everytime you update a Plant UML file and run `:Soil`, you'll get an updated image.\n- The generated image is saved in the same location that your Plant UML file.\n- To open the generated image without run Plant UML again use `:SoilOpenImg` command.\n\n## Screenshots\n### Simple use\n\n\u003cimg src=\"https://github.com/javiorfo/img/blob/master/nvim-soil/soil2.gif?raw=true\" alt=\"nvim-soil\"/\u003e\n\n**NOTE:** The colorscheme **nox** from [nvim-nyctophilia](https://github.com/javiorfo/nvim-nyctophilia) is used in this image.\n\n---\n\n### Donate\n- **Bitcoin** [(QR)](https://raw.githubusercontent.com/javiorfo/img/master/crypto/bitcoin.png)  `1GqdJ63RDPE4eJKujHi166FAyigvHu5R7v`\n- [Paypal](https://www.paypal.com/donate/?hosted_button_id=FA7SGLSCT2H8G)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaviorfo%2Fnvim-soil","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaviorfo%2Fnvim-soil","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaviorfo%2Fnvim-soil/lists"}