Standalone webpages within Flatfile Spaces for guidance and dynamic content
An example Welcome Document with steps for data import
actions
parameter when a document is created:
treatments
parameter which takes an array of treatments for your Document. Treatments can be used to categorize your Document. Certain treatments will cause your Document to look or behave differently.
"ephemeral"
will cause the Document to appear as a full-screen takeover, and it will not appear in the sidebar of your Space like other Documents. You can use ephemeral Documents to create a more focused experience for your end users.
"ephemeral"
is the only treatment that will change the behavior of your Document.
<embed>
HTML entity in your markdown and specifying which Block type you want to show using the type
attribute on the entity. Three Block types are currently supported: Embedded Workbook, Embedded Sheet, and Embedded Diff.
workbookId
(required): The ID of the workbook to embedname
(optional): Display name for the embedded workbookdefaultExpanded
(optional): Whether the workbook is expanded when the document loads (defaults to false)showHeader
(optional): Whether to show the workbook header (defaults to true). When false, the workbook is automatically expandedsheetId
(required): The ID of the sheet to embedworkbookId
(required): The ID of the workbook containing the sheetname
(optional): Display name for the embedded sheetdefaultExpanded
(optional): Whether the sheet is expanded when the document loads (defaults to false)showHeader
(optional): Whether to show the sheet header (defaults to true). When false, the sheet is automatically expandeddirection
attribute which specified whether the changes are displayed with the Snapshot as the end state (sheet_to_snapshot
) or the Sheet as the end state (snapshot_to_sheet
). The default value for direction is sheet_to_snapshot
.
Use direction="sheet_to_snapshot"
if you want to show changes that have been made since the time the Snapshot was taken, i.e. to review past changes. Use direction="snapshot_to_sheet"
if to preview the changes that would occur if you were to revert your Sheet back to the state it was in when the Snapshot was taken.