nixvim/plugins/by-name/headlines/default.nix

{ lib, config, ... }:
lib.nixvim.plugins.mkNeovimPlugin {
  name = "headlines";
  package = "headlines-nvim";
  description = "A plugin that adds horizontal highlights for text filetypes, like markdown, orgmode, and neorg.";

  maintainers = [ lib.maintainers.GaetanLepage ];

  settingsExample = {
    org.headline_highlights = false;
    norg = {
      headline_highlights = [ "Headline" ];
      codeblock_highlight = false;
    };
    markdown.headline_highlights = [ "Headline1" ];
  };

  extraConfig = {
    warnings = lib.nixvim.mkWarnings "plugins.headlines" {
      when = !config.plugins.treesitter.enable;

      message = ''
        headlines requires `plugins.treesitter` to be enabled with the relevant grammars installed.
      '';
    };
  };
}