Skip to content

Commit bfeb965

Browse files
committed
docs: update README.md, add placeholder structure document
1 parent cca15c5 commit bfeb965

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,12 @@ For the full codes, check our [Python Example Plugin](examples/python).
101101

102102
![](assets/screenshot.jpg)
103103

104+
## Placeholder Structure
105+
106+
The structure of a placeholder is `{<identifier>|<params>}`. Field `params` are optional and can be used to provide additional
107+
information to the placeholder. The format of `params` is decided by the processor of the placeholder indicated by `identifier`.
108+
When `params` is missing, you can simply write the placeholder as `{identifier}`.
109+
104110
## Built-in Placeholders
105111

106112
There are a number of built-in placeholders that can be used once papi is installed:

0 commit comments

Comments
 (0)