jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-22 03:16:52 -05:00
Code Issues Projects Releases Wiki Activity

Button to disable Markdown rendering (#21803)

Browse Source 
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
This commit is contained in:
Emma Makinson
2021-10-01 03:34:13 +01:00
committed by GitHub
parent 7c9fd0242c
commit ca9cf7e84f
4 changed files with 26 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md
View File

@@ -277,6 +277,14 @@ The footnote will render like this:
![Rendered footnote](/assets/images/site/rendered-footnote.png)
{% endif %}
## Hiding content with comments
You can tell {% data variables.product.product_name %} to hide content from the rendered Markdown by placing the content in an HTML comment.
<pre>
&lt;!-- This content will not appear in the rendered Markdown --&gt;
</pre>
## Ignoring Markdown formatting
You can tell {% data variables.product.product_name %} to ignore (or escape) Markdown formatting by using `\` before the Markdown character.
@@ -287,13 +295,13 @@ You can tell {% data variables.product.product_name %} to ignore (or escape) Mar
For more information, see Daring Fireball's "[Markdown Syntax](https://daringfireball.net/projects/markdown/syntax#backslash)."
## Hiding content with comments
{% ifversion fpt or ghes > 3.2 or ghae-issue-5232 %}
You can tell {% data variables.product.product_name %} to hide content from the rendered Markdown by placing the content in an HTML comment.
## Disabling Markdown rendering
<pre>
&lt;!-- This content will not appear in the rendered Markdown --&gt;
</pre>
{% data reusables.repositories.disabling-markdown-rendering %}
{% endif %}
## Further reading