Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown: FlowDoc table values generate as code blocks #163

Open
Fabian-Schmidt opened this issue Aug 28, 2024 · 1 comment
Open

Markdown: FlowDoc table values generate as code blocks #163

Fabian-Schmidt opened this issue Aug 28, 2024 · 1 comment

Comments

@Fabian-Schmidt
Copy link

Fabian-Schmidt commented Aug 28, 2024

Describe the bug

The Generated Markdown for FlowDoc can be converted by Markdown renderer instead of left as is.

Example is your from your Examples documents:

### Inputs
| Property | Value |
| -------- | ------------------------ |
| test | test |
| from | @variables('BodyToSend') |
| format | HTML |

Currently the table is generated as:

| Property | Value                    |
| -------- | ------------------------ |
| test     | test                     |
| from     | @variables('BodyToSend') |
| format   | HTML                     |

Rendered result:

Property Value
test test
from @variables('BodyToSend')
format HTML

In this example GitHub chooses to format @variables as link and bold. But this is incorrect. It is not a link to a GitHub handle. Instead it is just code.

Similar issue Expression row for column Value:

## Check\_if\_its\_Hotel
| Property | Value |
| ---------- | --------------------------------------------------------------- |
| Name | Check\_if\_its\_Hotel |
| Type | If |
| Expression | @contains(toLower(outputs('Compose_Flight_or_Hotel')), 'hotel') |

Expected behavior

The Value column may contains html tags or other code elements. Therefore it should be rendered as code block. This avoids issues with downstream Markdown renderer and also reflects the code elements of the values.

Proposed generated table:

| Property | Value                      |
| -------- | -------------------------- |
| test     | `test`                     |
| from     | `@variables('BodyToSend')` |
| format   | `HTML`                     |

Rendered result:

Property Value
test test
from @variables('BodyToSend')
format HTML
@Fabian-Schmidt Fabian-Schmidt changed the title FlowDoc Inouts tables should contain code blocks FlowDoc Inputs tables should contain code blocks Aug 28, 2024
@Fabian-Schmidt Fabian-Schmidt changed the title FlowDoc Inputs tables should contain code blocks Markdown: FlowDoc table values generate as code blocks Aug 28, 2024
@modery
Copy link
Owner

modery commented Aug 29, 2024

I've got this partially fixed. Not working in a few scenarios (e.g. compose actions that use variables), need to see what other ways there are to fix this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants