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

Escaping special characters in markdown #427

Closed
vincentclee opened this issue May 4, 2023 · 0 comments · Fixed by #505
Closed

Escaping special characters in markdown #427

vincentclee opened this issue May 4, 2023 · 0 comments · Fixed by #505

Comments

@vincentclee
Copy link

Escaping special characters in markdown.

https://tech.saigonist.com/b/code/escaping-special-characters-markdown.html

Example

See Inputs on https://github.com/npalm/action-docs-action#inputs

## Inputs

| parameter | description | required | default |
| --- | --- | --- | --- |
| readme | Readme file to update. | `false` | README.md |
| actionFile | THe action definition file. | `false` | action.yml |
| tocLevel | TOC level used for the headers. | `false` | 2 |
| lineBreaks | Line breaks to be used in updated readme (LF|CR|CRLF). | `false` | LF |

which renders like

Inputs

parameter description required default
readme Readme file to update. false README.md
actionFile THe action definition file. false action.yml
tocLevel TOC level used for the headers. false 2
lineBreaks Line breaks to be used in updated readme (LF CR CRLF).

it should render like

Inputs

parameter description required default
readme Readme file to update. false README.md
actionFile THe action definition file. false action.yml
tocLevel TOC level used for the headers. false 2
lineBreaks Line breaks to be used in updated readme (LF|CR|CRLF). false LF
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

Successfully merging a pull request may close this issue.

1 participant