Add missing headings to Test Page

This commit is contained in:
James Mills 2023-03-31 01:43:12 +10:00
parent b8655ffd7e
commit bfc510e804
No known key found for this signature in database
GPG Key ID: AC4C014F1440EBD6
1 changed files with 37 additions and 1 deletions

View File

@ -7,6 +7,42 @@ description: Basic Markdown Syntax and Test Page
Nearly all Markdown applications support the basic syntax outlined in the original Markdown design document. There are minor variations and discrepancies between Markdown processors — those are noted inline wherever possible.
## Headings
To create a heading, add number signs (`#`) in front of a word or phrase. The number of number signs you use should correspond to the heading level. For example, to create a heading level three (`<h3>`), use three number signs (e.g., `### My Header`).
| Markdown | HTML | Rendered Output |
| ------------------------ | -------------------------- | --------------- |
| `# Heading level 1` | `<h1>Heading level 1</h1>` | Heading level 1 |
| `## Heading level 2` | `<h2>Heading level 2</h2>` | Heading level 2 |
| `### Heading level 3` | `<h3>Heading level 3</h3>` | Heading level 3 |
| `#### Heading level 4` | `<h4>Heading level 4</h4>` | Heading level 4 |
| `##### Heading level 5` | `<h5>Heading level 5</h5>` | Heading level 5 |
| `###### Heading level 6` | `<h6>Heading level 6</h6>` | Heading level 6 |
### Alternate Syntax
Alternatively, on the line below the text, add any number of `==` characters for heading level 1 or `--` characters for heading level 2.
| Markdown | HTML | Rendered Output |
| -------------------------------- | -------------------------- | --------------- |
| `Heading level 1===============` | `<h1>Heading level 1</h1>` | Heading level 1 |
| `Heading level 2---------------` | `<h2>Heading level 2</h2>` | Heading level 2 |
### Heading Best Practices
Markdown applications dont agree on how to handle a missing space between the number signs (`#`) and the heading name. For compatibility, always put a space between the number signs and the heading name.
| ✅ Do this | ❌ Don't do this |
| -------------------- | ------------------- |
| `# Here's a Heading` | `#Here's a Heading` |
You should also put blank lines before and after a heading for compatibility.
| ✅ Do this | ❌ Don't do this |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| `Try to put a blank line before...# Heading...and after a heading.` | `Without blank lines, this might not look right.# HeadingDon't do this!` |
## Paragraphs
To create paragraphs, use a blank line to separate one or more lines of text.
@ -623,4 +659,4 @@ For security reasons, not all Markdown applications support HTML in Markdown doc
Use blank lines to separate block-level HTML elements like `<div>`, `<table>`, `<pre>`, and `<p>` from the surrounding content. Try not to indent the tags with tabs or spaces — that can interfere with the formatting.
You cant use Markdown syntax inside block-level HTML tags. For example, `<p>italic and **bold**</p>` wont work.
You cant use Markdown syntax inside block-level HTML tags. For example, `<p>italic and **bold**</p>` wont work.