Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

plugins.mkdnflow.settings

Options provided to the require('mkdnflow').setup function.

Type: open submodule of attribute set of lua value

Default:

{ }

Example:

{
  create_dirs = false;
  links = {
    conceal = true;
    style = "wiki";
  };
  modules = {
    bib = false;
    yaml = true;
  };
  perspective = {
    priority = "root";
    root_tell = ".git";
  };
  to_do = {
    status_order = [
      "not_started"
      "in_progress"
      "complete"
    ];
    statuses = {
      complete = {
        marker = "✓";
      };
      in_progress = {
        marker = "◐";
      };
      not_started = {
        marker = "✗";
      };
    };
  };
}

Declared by:

plugins.mkdnflow.settings.mappings

Key mappings for mkdnflow commands.

Use the generated positional format for mapping entries:

  • false to disable a command mapping.
  • [modes key], where modes is a string or list of mode strings.

Type: null or (attribute set of anything)

Default:

null

Declared by: