plugins.mkdnflow.enable

Whether to enable mkdnflow.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.mkdnflow.package

The mkdnflow.nvim package to use.

Type: package

Default: pkgs.vimPlugins.mkdnflow-nvim

Declared by:

plugins.mkdnflow.createDirs

  • true: Directories referenced in a link will be (recursively) created if they do not exist.
  • false: No action will be taken when directories referenced in a link do not exist. Neovim will open a new file, but you will get an error when you attempt to write the file.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.mkdnflow.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.mkdnflow.filetypes

A matching extension will enable the plugin’s functionality for a file with that extension.

NOTE: This functionality references the file’s extension. It does not rely on Neovim’s filetype recognition. The extension must be provided in lower case because the plugin converts file names to lowercase. Any arbitrary extension can be supplied. Setting an extension to false is the same as not including it in the list.

Type: null or (attribute set of (boolean or raw lua code))

Default: null

Plugin default:

{
  markdown = true;
  md = true;
  rmd = true;
}

Declared by:

plugins.mkdnflow.mappings

An attrs declaring the key mappings. The keys should be the name of a commands defined in mkdnflow.nvim/plugin/mkdnflow.lua (see :h Mkdnflow-commands for a list). Set to false to disable a mapping.

Type: null or (attribute set of (value false (singular enum) or (submodule) or raw lua code))

Default: null

Plugin default:

{
  MkdnCreateLink = false;
  MkdnCreateLinkFromClipboard = {
    key = "<leader>p";
    modes = [
      "n"
      "v"
    ];
  };
  MkdnDecreaseHeading = {
    key = "-";
    modes = "n";
  };
  MkdnDestroyLink = {
    key = "<M-CR>";
    modes = "n";
  };
  MkdnEnter = {
    key = "<CR>";
    modes = [
      "n"
      "v"
      "i"
    ];
  };
  MkdnExtendList = false;
  MkdnFoldSection = {
    key = "<leader>f";
    modes = "n";
  };
  MkdnFollowLink = false;
  MkdnGoBack = {
    key = "<BS>";
    modes = "n";
  };
  MkdnGoForward = {
    key = "<Del>";
    modes = "n";
  };
  MkdnIncreaseHeading = {
    key = "+";
    modes = "n";
  };
  MkdnMoveSource = {
    key = "<F2>";
    modes = "n";
  };
  MkdnNewListItem = false;
  MkdnNewListItemAboveInsert = {
    key = "O";
    modes = "n";
  };
  MkdnNewListItemBelowInsert = {
    key = "o";
    modes = "n";
  };
  MkdnNextHeading = {
    key = "]]";
    modes = "n";
  };
  MkdnNextLink = {
    key = "<Tab>";
    modes = "n";
  };
  MkdnPrevHeading = {
    key = "[[";
    modes = "n";
  };
  MkdnPrevLink = {
    key = "<S-Tab>";
    modes = "n";
  };
  MkdnSTab = false;
  MkdnTab = false;
  MkdnTableNewColAfter = {
    key = "<leader>ic";
    modes = "n";
  };
  MkdnTableNewColBefore = {
    key = "<leader>iC";
    modes = "n";
  };
  MkdnTableNewRowAbove = {
    key = "<leader>iR";
    modes = "n";
  };
  MkdnTableNewRowBelow = {
    key = "<leader>ir";
    modes = "n";
  };
  MkdnTableNextCell = {
    key = "<Tab>";
    modes = "i";
  };
  MkdnTableNextRow = false;
  MkdnTablePrevCell = {
    key = "<S-Tab>";
    modes = "i";
  };
  MkdnTablePrevRow = {
    key = "<M-CR>";
    modes = "i";
  };
  MkdnToggleToDo = {
    key = "<C-Space>";
    modes = [
      "n"
      "v"
    ];
  };
  MkdnUnfoldSection = {
    key = "<leader>F";
    modes = "n";
  };
  MkdnUpdateNumbering = {
    key = "<leader>nn";
    modes = "n";
  };
  MkdnYankAnchorLink = {
    key = "ya";
    modes = "n";
  };
  MkdnYankFileAnchorLink = {
    key = "yfa";
    modes = "n";
  };
}

Declared by:

plugins.mkdnflow.silent

  • true: The plugin will not display any messages in the console except compatibility warnings related to your config.
  • false: The plugin will display messages to the console (all messages from the plugin start with ⬇️ ).

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.mkdnflow.wrap

  • true: When jumping to next/previous links or headings, the cursor will continue searching at the beginning/end of the file.
  • false: When jumping to next/previous links or headings, the cursor will stop searching at the end/beginning of the file.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by: