phelipetls / vim-hugo

Vim plugin for web development with static site generator Hugo

vim-hugo

This is a Vim plugin for web development with the static site generator Hugo.

HTML

• syntax highlighting and identation is improved to support the HTML Go template syntax.
• :h path includes default directories used by Hugo, like layouts/partials, which is convenient to start editing files with :h gf and friends.
• matchit patterns are extended to support Go template.
• A compiler plugin is made available so you can build your website from inside Vim with compiler hugo | make, and build errors will populate the quickfix list.

Markdown

Markdown syntax highlight is also improved to add support for shortcodes and YAML front matter.

Embedded languages inside the {{< highlight >}} shortcode will be highlighted. For example, to highlight Python code, add let g:markdown_fenced_languages=['python'] to your .vimrc or init.vim.

{{< highlight python >}}
import foo
{{< /highlight >}}

If you want to highlight JavaScript code with js as a shorthand, use let g:markdown_fenced_languages=['js=javascript']:

{{< highlight js >}}
import { bar } from './foo'
{{< /highlight >}}

This is reused from Vim's built-in syntax files for markdown, so it'll also be used for markdown code blocks.

vim-hugo's Issues

Undefined variable: g:markdown_fenced_languages

This error shows up whenever I open a markdown file. I'm using neovim 0.6.0, here's my configuration: https://gitlab.com/gabmus/mydotfiles/-/tree/master/nvim/dot-config/nvim

Not detecting files with only {{- end -}}

Hi. Thanks for this plugin.

It doesn't seem to identify some of my template files, apparently because I use {{- end -}} rather than {{ end }}.

Here's a quick fix that works for me:

diff --git a/ftdetect/html.vim b/ftdetect/html.vim
index 97561fa..6073d0a 100644
--- a/ftdetect/html.vim
+++ b/ftdetect/html.vim
@@ -3,6 +3,8 @@ function! s:DetectGoTemplate()
     set ft=htmlhugo
   elseif search('{{\s*end\s*}}')
     set ft=htmlhugo
+  elseif search('{{-\s*end\s*-}}')
+    set ft=htmlhugo
   elseif search('{{\s*$\k\+\s*:=')
     set ft=htmlhugo
   elseif search('{{\s*\.[A-Z]')

It may also need similar tweaks to some of those other tests.

Cheers,

Chris