Skip to content

Commit

Permalink
readme_file.md: typo and lightened wording (#1564)
Browse files Browse the repository at this point in the history
  • Loading branch information
ajoga authored Jun 16, 2024
1 parent 70d2a06 commit b5b4530
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/documentation/readme_file.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,4 +168,4 @@ Create a PR at the [content-docs repo](https://github.com/demisto/content-docs)

## Notes

We use [MDX](https://mdxjs.com/) for the Markdown generation. MDX is a superset of standard Markdown, but it requires that any html used in the document must be jsx complaint. Meaning all html tags need to contain a closing tag. For example don't use: `<br>`, use: `<br/>`. Additionally, html entities `< >`, not in code blocks, need to be encoded. Use `&lt;` and `&gt;` to encode. As part of the CircleCI build, the README.md file will be validated that it is MDX complaint.
We use [MDX](https://mdxjs.com/) for the Markdown generation. MDX is a superset of standard Markdown, but it requires that any html used in the document must be jsx compliant. Meaning all html tags need to contain a closing tag. For example don't use: `<br>`, use: `<br/>`. Additionally, html entities `< >` not in code blocks, need to be html-encoded. Use `&lt;` and `&gt;` to encode. As part of the CircleCI build, the README.md file will be validated for MDX compliance.

0 comments on commit b5b4530

Please sign in to comment.