When editing a Portal in Portal 3.0, you'll have the option to add Help Content that will appear on the right side of your Portal. There are two ways to set your Help Content: in the Dashboard, or when creating your Portal in the Platform SDK.
Editing Help Content in the Dashboard:
To access and edit your content, open up a Portal under Configuration > Portal. Beneath your Private Key you'll see a box labeled "Help Content", and you can add your help text here.
Our help content box uses Github-flavored markdown for formatting. Some examples of how to use this are indicated below:
Headers:
# H1
## H2
### H3
#### H4
##### H5
###### H6
Emphasis:
Emphasis, aka italics, with *asterisks* or _underscores_.
Strong emphasis, aka bold, with **asterisks** or __underscores__.
Combined emphasis with **asterisks and _underscores_**.
Links:
[I'm an inline-style link](https://www.flatfile.com)
In Flatfile's Portal, the above examples would look like this:
In the Flatfile Platform SDK:
When creating your Portal in the Flatfile Platform SDK, you are able to specify an option of helpContent for your Portal that lets you add in a Help Content message. Here is an example of what this could look like:
const CustomersPortal = new Portal({
name: "Customer Portal",
helpContent:
"# Properties\n\n" +
"Some example markdown\n\n" +
"- List item 1\n- List item 2",
sheet: "CustomersSheet",
});
Comments
0 comments
Please sign in to leave a comment.