From bfc510e8040980a0b669b1923a53ea5b02f87bc2 Mon Sep 17 00:00:00 2001 From: James Mills <1290234+prologic@users.noreply.github.com> Date: Fri, 31 Mar 2023 01:43:12 +1000 Subject: [PATCH] Add missing headings to Test Page --- TestPage.md | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/TestPage.md b/TestPage.md index 28ac6b7..dcfac91 100644 --- a/TestPage.md +++ b/TestPage.md @@ -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 (`

`), use three number signs (e.g., `### My Header`). + +| Markdown | HTML | Rendered Output | +| ------------------------ | -------------------------- | --------------- | +| `# Heading level 1` | `

Heading level 1

` | Heading level 1 | +| `## Heading level 2` | `

Heading level 2

` | Heading level 2 | +| `### Heading level 3` | `

Heading level 3

` | Heading level 3 | +| `#### Heading level 4` | `

Heading level 4

` | Heading level 4 | +| `##### Heading level 5` | `
Heading level 5
` | Heading level 5 | +| `###### Heading level 6` | `
Heading level 6
` | 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===============` | `

Heading level 1

` | Heading level 1 | +| `Heading level 2---------------` | `

Heading level 2

` | Heading level 2 | + +### Heading Best Practices + +Markdown applications don’t 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 `
`, ``, `
`, and `

` from the surrounding content. Try not to indent the tags with tabs or spaces — that can interfere with the formatting. -You can’t use Markdown syntax inside block-level HTML tags. For example, `

italic and **bold**

` won’t work. \ No newline at end of file +You can’t use Markdown syntax inside block-level HTML tags. For example, `

italic and **bold**

` won’t work.