README
markdown (OperationClassification ui-esm)
this uses react-markdown
to render markdown in the browser with react...
This is a ui-esm operation. This means it's a ui operation that builds to javascript with ESM module resolving... It was based on this example: https://prateeksurana.me/blog/react-library-with-typescript/
Renders a markdown string (without frontmatter)
TODO:
- Show selection prompt-results In renderMarkdownContent, augment the alineas with the ContextualPromptResult. Would be great to see the results when hovering over the selected thing, or maybe showing it with a button, or inline, even.
Input | ||
---|---|---|
content | string | |
Output | JSX.Element |
Renders a markdown string (without frontmatter)
TODO:
- Show selection prompt-results In renderMarkdownContent, augment the alineas with the ContextualPromptResult. Would be great to see the results when hovering over the selected thing, or maybe showing it with a button, or inline, even.
<MarkdownCodeblock />
Renders a markdown codeblock with a text as content and an optional extension
Input | ||
---|---|---|
props | { text: string, extension?: string, minimalMode?: CodeblockMode , expandedMode?: CodeblockMode , isInitiallyExpanded?: boolean, isModeStatic?: boolean, } | |
Output | JSX.Element |
Renders a markdown codeblock with a text as content and an optional extension
Based on markdown info, gest the real source for an asset
Input | ||
---|---|---|
src (optional) | string | |
Output | string |
Properties:
Name | Type | Description |
---|---|---|
disableSelectionContextMenu (optional) | boolean | |
projectRelativeBaseFolderPath (optional) | string | |
projectRelativeMarkdownFilePath (optional) | string | |
augmentedWordObject (optional) | object | |
selectionPrompts (optional) | array | |
selectionContextualPromptResults (optional) | array | |
fileContextualPromptResults (optional) | array | |
isStatic (optional) | boolean | |
isDev (optional) | boolean | |
big (optional) | boolean |
Based on markdown info, gest the real source for an asset
Show internal (21)
gets the renderable asset url from the relative url
Input | ||
---|---|---|
relativeUrl | string | |
Output | string |
Input | ||
---|---|---|
url (optional) | string | |
Output | string |
<HtmlHeader />
Input | ||
---|---|---|
- | ||
Output | JSX.Element |
<Parameter />
In markdown, if you wish to refer to a parameter, you can backtick it and put a "." in front. You can also add a value to it if you wish, by adding the ":" and the value afterwards.
Input | ||
---|---|---|
props | { text: string, } | |
Output | JSX.Element |
Renders markdown frontmatter parameters (and optionally a spacer)
Input | ||
---|---|---|
parameters | Frontmatter | |
Output | JSX.Element |
renders a MarkdownChunk interface
Input | ||
---|---|---|
chunk | MarkdownChunk | |
Output | JSX.Element |
renders the MardkownParse interface (including frontmatter)
Input | ||
---|---|---|
markdownParse | MarkdownParse | |
Output | JSX.Element |
renders a markdown title (level should be 1 for h1 and 6 for h6)
Input | ||
---|---|---|
title | string | |
Output | JSX.Element |
Input | ||
---|---|---|
- | ||
Output |
gets the renderable asset url from the relative url
In markdown, if you wish to refer to a parameter, you can backtick it and put a "." in front. You can also add a value to it if you wish, by adding the ":" and the value afterwards.
Renders markdown frontmatter parameters (and optionally a spacer)
renders a MarkdownChunk interface
renders the MardkownParse interface (including frontmatter)
renders a markdown title (level should be 1 for h1 and 6 for h6)
README
markdown (OperationClassification ui-esm)
this uses react-markdown
to render markdown in the browser with react...
This is a ui-esm operation. This means it's a ui operation that builds to javascript with ESM module resolving... It was based on this example: https://prateeksurana.me/blog/react-library-with-typescript/
Renders a markdown string (without frontmatter)
TODO:
- Show selection prompt-results In renderMarkdownContent, augment the alineas with the ContextualPromptResult. Would be great to see the results when hovering over the selected thing, or maybe showing it with a button, or inline, even.
Input | ||
---|---|---|
content | string | |
Output | JSX.Element |
Renders a markdown string (without frontmatter)
TODO:
- Show selection prompt-results In renderMarkdownContent, augment the alineas with the ContextualPromptResult. Would be great to see the results when hovering over the selected thing, or maybe showing it with a button, or inline, even.
<MarkdownCodeblock />
Renders a markdown codeblock with a text as content and an optional extension
Input | ||
---|---|---|
props | { text: string, extension?: string, minimalMode?: CodeblockMode , expandedMode?: CodeblockMode , isInitiallyExpanded?: boolean, isModeStatic?: boolean, } | |
Output | JSX.Element |
Renders a markdown codeblock with a text as content and an optional extension
Based on markdown info, gest the real source for an asset
Input | ||
---|---|---|
src (optional) | string | |
Output | string |
Properties:
Name | Type | Description |
---|---|---|
disableSelectionContextMenu (optional) | boolean | |
projectRelativeBaseFolderPath (optional) | string | |
projectRelativeMarkdownFilePath (optional) | string | |
augmentedWordObject (optional) | object | |
selectionPrompts (optional) | array | |
selectionContextualPromptResults (optional) | array | |
fileContextualPromptResults (optional) | array | |
isStatic (optional) | boolean | |
isDev (optional) | boolean | |
big (optional) | boolean |
Based on markdown info, gest the real source for an asset
Show internal (21)
gets the renderable asset url from the relative url
Input | ||
---|---|---|
relativeUrl | string | |
Output | string |
Input | ||
---|---|---|
url (optional) | string | |
Output | string |
<HtmlHeader />
Input | ||
---|---|---|
- | ||
Output | JSX.Element |
<Parameter />
In markdown, if you wish to refer to a parameter, you can backtick it and put a "." in front. You can also add a value to it if you wish, by adding the ":" and the value afterwards.
Input | ||
---|---|---|
props | { text: string, } | |
Output | JSX.Element |
Renders markdown frontmatter parameters (and optionally a spacer)
Input | ||
---|---|---|
parameters | Frontmatter | |
Output | JSX.Element |
renders a MarkdownChunk interface
Input | ||
---|---|---|
chunk | MarkdownChunk | |
Output | JSX.Element |
renders the MardkownParse interface (including frontmatter)
Input | ||
---|---|---|
markdownParse | MarkdownParse | |
Output | JSX.Element |
renders a markdown title (level should be 1 for h1 and 6 for h6)
Input | ||
---|---|---|
title | string | |
Output | JSX.Element |
Input | ||
---|---|---|
- | ||
Output |
gets the renderable asset url from the relative url
In markdown, if you wish to refer to a parameter, you can backtick it and put a "." in front. You can also add a value to it if you wish, by adding the ":" and the value afterwards.
Renders markdown frontmatter parameters (and optionally a spacer)
renders a MarkdownChunk interface
renders the MardkownParse interface (including frontmatter)
renders a markdown title (level should be 1 for h1 and 6 for h6)