mirror of
https://github.com/github/awesome-copilot.git
synced 2026-02-20 18:35:14 +00:00
2.6 KiB
2.6 KiB
Code Blocks to HTML
Fenced Code Blocks (No Language)
Markdown
function test() {
console.log("notice the blank line before this function?");
}
Parsed HTML
<pre><code>
function test() {
console.log("notice the blank line before this function?");
}
</code></pre>
GitHub Tip Callout
Markdown
> [!TIP]
> To preserve your formatting within a list, make sure to indent non-fenced code blocks by eight spaces.
Parsed HTML (GitHub-specific)
<blockquote class="markdown-alert markdown-alert-tip">
<p><strong>Tip</strong></p>
<p>To preserve your formatting within a list, make sure to indent non-fenced code blocks by eight spaces.</p>
</blockquote>
Showing Backticks Inside Code Blocks
Markdown
````
```
Look! You can see my backticks.
```
````
Parsed HTML
<pre><code>
```
Look! You can see my backticks.
```
</code></pre>
Syntax Highlighting (Language Identifier)
Markdown
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
Parsed HTML
<pre><code class="language-ruby">
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
</code></pre>
The
language-rubyclass is consumed by GitHub’s syntax highlighter (Linguist + grammar).
Summary: Syntax-Highlighting Rules (HTML-Level)
| Markdown fence | Parsed <code> tag |
|---|---|
| ```js | <code class="language-js"> |
| ```html | <code class="language-html"> |
| ```md | <code class="language-md"> |
| ``` (no lang) | <code> |
HTML Comments (Ignored by Renderer)
<!-- Internal documentation comment -->
<!-- Internal documentation comment -->
Links
[About writing and formatting on GitHub](https://docs.github.com/...)
<a href="https://docs.github.com/...">About writing and formatting on GitHub</a>
Lists
* [GitHub Flavored Markdown Spec](https://github.github.com/gfm/)
<ul>
<li>
<a href="https://github.github.com/gfm/">GitHub Flavored Markdown Spec</a>
</li>
</ul>
Diagrams (Conceptual Parsing)
Markdown
```mermaid
graph TD
A --> B
```
Parsed HTML
<pre><code class="language-mermaid">
graph TD
A --> B
</code></pre>
Closing Notes
- No
language-*class appears here because no language identifier was provided. - The inner triple backticks are preserved as literal text inside
<code>.