plugins.mkdnflow.links.conceal

  • true: Link sources and delimiters will be concealed (depending on which link style is selected)
  • false: Link sources and delimiters will not be concealed by mkdnflow

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.mkdnflow.links.context

  • 0 (default): When following or jumping to links, assume that no link will be split over multiple lines
  • n: When following or jumping to links, consider n lines before and after a given line (useful if you ever permit links to be interrupted by a hard line break)

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: 0

Declared by:

plugins.mkdnflow.links.implicitExtension

A string that instructs the plugin (a) how to interpret links to files that do not have an extension, and (b) that new links should be created without an explicit extension.

Type: null or string

Default: null

Declared by:

plugins.mkdnflow.links.style

  • markdown: Links will be expected in the standard markdown format: [<title>](<source>)
  • wiki: Links will be expected in the unofficial wiki-link style, specifically the title-after-pipe format (see https://github.com/jgm/pandoc/pull/7705): [[<source>|<title>]].

Type: null or one of “markdown”, “wiki” or raw lua code

Default: null

Plugin default: "markdown"

Declared by:

plugins.mkdnflow.links.transformExplicit

A function that transforms the text to be inserted as the source/path of a link when a link is created. Anchor links are not currently customizable. If you want all link paths to be explicitly prefixed with the year, for instance, and for the path to be converted to uppercase, you could provide the following function under this key. (NOTE: The previous functionality specified under the prefix key has been migrated here to provide greater flexibility.)

Example:

  function(input)
      return(string.upper(os.date('%Y-')..input))
  end

Type: null or lua function string or value false (singular enum)

Default: null

Plugin default: false

Declared by:

plugins.mkdnflow.links.transformImplicit

A function that transforms the path of a link immediately before interpretation. It does not transform the actual text in the buffer but can be used to modify link interpretation. For instance, link paths that match a date pattern can be opened in a journals subdirectory of your notebook, and all others can be opened in a pages subdirectory, using the following function:

  function(input)
      if input:match('%d%d%d%d%-%d%d%-%d%d') then
          return('journals/'..input)
      else
          return('pages/'..input)
      end
  end

Type: null or lua function string or value false (singular enum)

Default: null

Plugin default:

''
  function(text)
      text = text:gsub(" ", "-")
      text = text:lower()
      text = os.date('%Y-%m-%d_')..text
      return(text)
  end
''

Declared by: