jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Fix inconsistent alerts by using the markdown notation - part 2 (#35221)

Browse Source 
Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com>
This commit is contained in:
Artur Kordowski
2024-11-08 18:20:31 +01:00
committed by GitHub
parent 0208d54f08
commit b1a68cb155
292 changed files with 1230 additions and 2749 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md
View File

@@ -43,11 +43,8 @@ If you add a task list to the body of an issue, the list has added functionality
{% data reusables.repositories.task-list-markdown %}
{% tip %}
**Tip:** You cannot create task list items within closed issues or issues with linked pull requests.
{% endtip %}
> [!TIP]
> You cannot create task list items within closed issues or issues with linked pull requests.
## Reordering tasks

41
content/get-started/writing-on-github/working-with-advanced-formatting/attaching-files.md
View File

@@ -16,21 +16,16 @@ topics:
---
{% ifversion ghes %}
{% warning %}
**Warning:** When you upload an image or video to a pull request or issue comment, or upload a file to a ticket in the {% data variables.contact.landing_page_portal %}, anyone can view the anonymized URL without authentication, even if the pull request or issue is in a private repository, or if private mode is enabled. To keep sensitive media files private, serve them from a private network or server that requires authentication.
> [!WARNING]
> When you upload an image or video to a pull request or issue comment, or upload a file to a ticket in the {% data variables.contact.landing_page_portal %}, anyone can view the anonymized URL without authentication, even if the pull request or issue is in a private repository, or if private mode is enabled. To keep sensitive media files private, serve them from a private network or server that requires authentication.
{% endwarning %}
{% endif %}
{% ifversion fpt or ghec %}
{% note %}
**Note:** For public repositories, uploaded files can be accessed without authentication.
In the case of private and internal repositories, only people with access to the repository can view the uploaded files.
{% endnote %}
> [!NOTE]
> For public repositories, uploaded files can be accessed without authentication. In the case of private and internal repositories, only people with access to the repository can view the uploaded files.
{% endif %}
@@ -48,11 +43,8 @@ To attach a file to an issue or pull request conversation, drag and drop it into
When you attach a file, it is uploaded immediately to {% data variables.product.product_name %} and the text field is updated to show the anonymized URL for the file. {% ifversion fpt or ghec %}For more information on anonymized URLs see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-anonymized-urls)."{% endif %}
{% note %}
**Note:** In many browsers, you can copy-and-paste images directly into the box.
{% endnote %}
> [!NOTE]
> In many browsers, you can copy-and-paste images directly into the box.
The maximum file size is:
@@ -62,11 +54,8 @@ The maximum file size is:
* 100MB for videos{% endif %}
* 25MB for all other files
{% note %}
**Note:** To upload videos greater than 10MB to a repository owned by a user or organization on a paid {% data variables.product.prodname_dotcom %} plan, you must either be an organization member or outside collaborator, or be on a paid plan.
{% endnote %}
> [!NOTE]
> To upload videos greater than 10MB to a repository owned by a user or organization on a paid {% data variables.product.prodname_dotcom %} plan, you must either be an organization member or outside collaborator, or be on a paid plan.
We support these files:
@@ -82,18 +71,12 @@ We support these files:
* Text files (`.txt`)
* Patch files (`.patch`)
{% note %}
**Note:** If you use Linux and try to upload a `.patch` file, you will receive an error message. This is a known issue.
{% endnote %}
> [!NOTE]
> If you use Linux and try to upload a `.patch` file, you will receive an error message. This is a known issue.
* PDFs (`.pdf`)
* ZIP (`.zip`, `.gz`, `.tgz`)
* Video (`.mp4`, `.mov`, `.webm`)
{% note %}
**Note:** Video codec compatibility is browser specific, and it's possible that a video you upload to one browser is not viewable on another browser. At the moment we recommend using H.264 for greatest compatibility.
{% endnote %}
> [!NOTE]
> Video codec compatibility is browser specific, and it's possible that a video you upload to one browser is not viewable on another browser. At the moment we recommend using H.264 for greatest compatibility.

14
content/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls.md
View File

@@ -25,11 +25,8 @@ For more information on creating links, see "[AUTOTITLE](/get-started/writing-on
Within conversations on {% data variables.product.product_name %}, references to issues and pull requests are automatically converted to shortened links.
{% note %}
**Note:** Autolinked references are not created in wikis or files in a repository.
{% endnote %}
> [!NOTE]
> Autolinked references are not created in wikis or files in a repository.
| Reference type | Raw reference | Short link |
| --- | --- | --- |
@@ -53,11 +50,8 @@ The URL of a label can be found by navigating to the labels page and clicking on
https://github.com/github/docs/labels/enhancement
```
{% note %}
**Note:** If the label name contains a period (`.`), the label will not automatically render from the label URL.
{% endnote %}
> [!NOTE]
> If the label name contains a period (`.`), the label will not automatically render from the label URL.
## Commit SHAs

7
content/get-started/writing-on-github/working-with-advanced-formatting/creating-a-permanent-link-to-a-code-snippet.md
View File

@@ -21,11 +21,8 @@ This type of permanent link will render as a code snippet only in the repository
![Screenshot of an issue comment. A code snippet has a header that lists the file name and line numbers, and a body that lists the code on those lines.](/assets/images/help/repository/rendered-code-snippet.png)
{% tip %}
**Tip:** To create a permalink for an entire file, see "[AUTOTITLE](/repositories/working-with-files/using-files/getting-permanent-links-to-files)."
{% endtip %}
> [!TIP]
> To create a permalink for an entire file, see "[AUTOTITLE](/repositories/working-with-files/using-files/getting-permanent-links-to-files)."
{% data reusables.repositories.navigate-to-repo %}
1. Locate the code you'd like to link to:

7
content/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md
View File

@@ -26,11 +26,8 @@ function test() {
![Screenshot of rendered {% data variables.product.prodname_dotcom %} Markdown showing how triple backticks render code blocks in raw formatting. The block begins with "function test() {."](/assets/images/help/writing/fenced-code-block-rendered.png)
{% tip %}
**Tip:** To preserve your formatting within a list, make sure to indent non-fenced code blocks by eight spaces.
{% endtip %}
> [!TIP]
> To preserve your formatting within a list, make sure to indent non-fenced code blocks by eight spaces.
To display triple backticks in a fenced code block, wrap them inside quadruple backticks.

7
content/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams.md
View File

@@ -32,11 +32,8 @@ graph TD;
![Screenshot of a rendered Mermaid flow chart with four lavender boxes labeled A, B, C, and D. Arrows extend from A to B, B to D, A to C, and C to D.](/assets/images/help/writing/mermaid-flow-chart.png)
{% note %}
**Note:** You may observe errors if you run a third-party Mermaid plugin when using Mermaid syntax on {% data variables.product.company_short %}.
{% endnote %}
> [!NOTE]
> You may observe errors if you run a third-party Mermaid plugin when using Mermaid syntax on {% data variables.product.company_short %}.
### Checking your version of Mermaid

10
content/get-started/writing-on-github/working-with-saved-replies/using-saved-replies.md
View File

@@ -18,13 +18,9 @@ versions:
1. From the list, select the saved reply you'd like to add to your comment. Optionally, edit the content of the saved reply.
1. Select **Comment** to add your comment.
{% tip %}
**Tips:**
* You can use a keyboard shortcut to autofill the comment with a saved reply. For more information, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#comments)."
* You can filter the list by typing the title of the saved reply.
{% endtip %}
> [!TIP]
> * You can use a keyboard shortcut to autofill the comment with a saved reply. For more information, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#comments)."
> * You can filter the list by typing the title of the saved reply.
## Further reading