1. Remark
  2. User documentation
  3. Remark syntax
  4. Macros
  5. Available macros
  6. Ref macro

Ref macro

Back to Available macros

The Ref macro returns the relative output-names of the given documents. Its purpose is to allow using Markdown links in the text, while still making use of implicit Remark-linking.

Properties

Output expansion default

Disabled.

Parameters

A list of files for which the links are to be generated.

Variables

None.

Example

When links need to be [given specific names][1], they can use
the combination of a Markdown link with the Ref macro in the
definition of the link.

[1]: [[Ref: Ref_Macro.txt]]

When links need to be given specific names, they can use the combination of a Markdown link with the Ref macro in the definition of the link.

See also

File searching algorithm

Files

Ref macro

Finds the relative output name of a file in document tree.