Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

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

Browse source
This commit is contained in:
Even Brenden 2022-01-25 17:59:03 +01:00 committed by GitHub
parent 183fb3e327
commit bd8b7ca62b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/using-the-pandoc-api.md
View file

@ -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