Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaytyrrell13/static.nvim
Plugin for Neovim to enhance the experience of developing a site using a static site generator.
https://github.com/jaytyrrell13/static.nvim
neovim neovim-plugin nvim
Last synced: 17 days ago
JSON representation
Plugin for Neovim to enhance the experience of developing a site using a static site generator.
- Host: GitHub
- URL: https://github.com/jaytyrrell13/static.nvim
- Owner: jaytyrrell13
- License: mit
- Created: 2023-08-04T22:06:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-29T19:53:52.000Z (11 months ago)
- Last Synced: 2024-10-14T18:41:34.310Z (25 days ago)
- Topics: neovim, neovim-plugin, nvim
- Language: Lua
- Homepage:
- Size: 28.3 KB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - jaytyrrell13/static.nvim - Run static site generator commands. (Code Runner / Quickfix)
README
# static.nvim
Plugin for Neovim to enhance the experience of developing a site using a static site generator.
## Installation
[Lazy](https://github.com/folke/lazy.nvim):
```lua
{
'jaytyrrell13/static.nvim',
opts = {},
keys = {
{ 'Sb', ':Static build' },
{ 'Ss', ':Static serve' },
{ 'Sp', ':Static prod' },
},
}
```
[Packer](https://github.com/wbthomason/packer.nvim):
```lua
use {
'jaytyrrell13/static.nvim',
config = function()
require('static').setup()
end
}
```
Add your preferred mappings to your configuration:
```
nmap Sb :Static build
nmap Ss :Static serve
nmap Sp :Static prod
```
## Usage
Running `:Static build` for example, will determine the Static Site Generator and then run the build command that is configured in [runners.lua](https://github.com/jaytyrrell13/static.nvim/blob/main/lua/static/runners.lua).
If you'd like to run a specific Static Site Generator, you can specify it in the command like `:Static astro build`.
Supported Static Site Generators:
- [11ty](https://www.11ty.dev/)
- [Astro](https://astro.build/)
- [Gatsby](https://www.gatsbyjs.com/)
- [Hexo](https://hexo.io/)
- [Hugo](https://gohugo.io/)
- [Jigsaw](https://jigsaw.tighten.com/)
- [Next.js](https://nextjs.org/)
- [Nuxt](https://nuxt.com/)
### Commands
| Command | Description |
| :-----: | :---------: |
| `build` | Build the site for local development |
| `serve` | Start a webserver to view the site |
| `prod` | Build the site for production |
**Note:** Some Static Site Generators do not support the `prod` command, use the `build` command instead.
### Parameters
Any parameters passed to one of the commands is passed along to the underlying command. For example, if you'd like to use a different port for the `serve` command, you can run:
```sh
:Static serve --port=8081
```
## Strategies
This plugin can execute the SSG commands using different methods called "strategies".
| Strategy | Identifier | Description |
| :---: | :---: | :--- |
| Basic (default) | `basic` | Runs commands using `!` |
| Neovim | `neovim` | Runs commands using `:terminal` in a horizontal split |
| Dispatch | `dispatch` `dispatch_background` | Runs commands using `:Dispatch` or `:Dispatch!` |
## Configuration
**static.nvim** comes with the following defaults:
```lua
{
strategy = 'basic',
}
```
## Snippets
This plugin also includes snippets for Astro. To use them, add this plugin as a dependency of LuaSnip.
```lua
{
'L3MON4D3/LuaSnip',
dependencies = {
'jaytyrrell13/static.nvim',
}
}
```
Also, make sure to have this line in your config for LuaSnip.
```lua
require('luasnip.loaders.from_vscode').lazy_load()
```
## Support
If you'd like to support the development of `static.nvim`, you can [buy me a coffee](https://www.buymeacoffee.com/jaytyrrell).