Add metadata file paragraph to Pandoc API doc (#7865)

1 files changed, 10 insertions, 0 deletions

diff --git a/doc/using-the-pandoc-api.md b/doc/using-the-pandoc-api.md
index d44e82e9b..70075fdd3 100644
--- a/doc/using-the-pandoc-api.md
+++ b/doc/using-the-pandoc-api.md
@@ -317,6 +317,16 @@ file in the "user data directory" (`setUserDataDir`,
 return the default installed with the system.
 To force the use of the default, `setUserDataDir Nothing`.
 
+# Metadata files
+
+Pandoc can add metadata to documents, as described in the
+User's Guide. Similar to data files, metadata YAML files can
+be retrieved using `readMetadataFile` from Text.Pandoc.Class.
+`readMetadataFile` will first look for the file in the working
+directory, and if it is not found there, it will look for it
+in the `metadata` subdirectory of the user data directory
+(`setUserDataDir`, `getUserDataDir`).
+
 # Templates
 
 Pandoc has its own template system, described in the User's