Rest assured, the dev docs site will display the video properly as can be seen at the following example. Note: GitHub markdown preview will not display the video (it will show the browser not supported message). You may also use this URL as the absolute URL.Įmbed the image in the README.md using a Markdown Image Link, such as: Note: if you click the Download button, GitHub will perform a redirect and the url in the browser will point to the domain:.The URL should refer to a commit hash or the master branch. Make sure the URL you are copying is not referring to a branch which will be deleted after the PR is merged.View the file in the GitHub web interface.To obtain an absolute URL to an image from GitHub: Make sure to view the README.md file in GitHub's web interface and validate that the images display properly.ĭocumentation with Relative URL examples: Make sure to check this file in to git, so if needed to regenerate the documentation in the future, the commands are easily available. If there are duplicates of a command included in the text file, only the output of the command's first execution will be included in the generated documentation output.Ĭreate a command_examples.txt file in the same directory as the Integration. The command examples should appear the same way they would as in the CLI in Cortex XSOAR, for example !url url=8.8.8.8.Ĭommands will be executed one at a time, in the order in which they appear in the file. To automatically generate example output (human readable and context), you should create a text file containing command examples, one per line. Command Examples - Integration Documentation # Documentation for the command is available here. Use the demisto-sdk generate-docs command to generate documentation for your content entity. The entity README.md file should not be confused with the Content Pack README.md file (documented here) or the integration description file, documented here.

Readme md example