From a72a415a88ee8003eba8acf24cf0834850f68789 Mon Sep 17 00:00:00 2001 From: Jess Hosman <1183847+jhosman@users.noreply.github.com> Date: Tue, 2 Aug 2022 15:19:50 -0600 Subject: [PATCH] Add more details in workflow file name section --- .../adding-a-workflow-status-badge.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/content/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge.md b/content/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge.md index 906ff89291..fad588ab5c 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge.md @@ -22,11 +22,13 @@ To add a workflow status badge to your `README.md` file, first find the URL for ## Using the workflow file name -You can reference a workflow status badge using the name of the workflow file: +You can find the URL for a workflow status badge using the name of the workflow file: -```markdown -![example workflow]({% ifversion fpt or ghec %}https://github.com{% else %}{% endif %}///actions/workflows//badge.svg) ``` +{% ifversion fpt or ghec %}https://github.com{% else %}{% endif %}///actions/workflows//badge.svg +``` + +To display the workflow status badge in your `README.md` file, use the Markdown markup for embedding images. For more information about image markup in Markdown, see "[Basic writing and formatting syntax](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#images)." For example, add the following Markdown to your `README.md` file to add a status badge for a workflow with the file path `.github/workflows/main.yml`. The `OWNER` of the repository is the `github` organization and the `REPOSITORY` name is `docs`.