action-docs
action-docs copied to clipboard
pipe `|` is not properly escaped
Having | symbols in input or output description is breaking the table creation due to the lack of a proper escape.
Hello Niek, I'm currently having trouble with this. Although I found a workaround for my work setup, it would be nice to have this fixed. In my action I have this input:
inputs:
branch:
description: 'Branch'
required: false
default: ${{ github.base_ref || github.ref_name }}
The problem is that I cannot change that default value. The result is this:
| `branch` | <p>Branch</p> | `false` | `${{ github.base_ref || github.ref_name }}` |
Just to remember we also have this section (wich is good):
Solution
The script could replace |
to \|
, only when creating the table, at least at the default parameters.
Thank you.