From 69b185ff5eb06717148bf7da8417b27969e3b753 Mon Sep 17 00:00:00 2001 From: taw00 Date: Wed, 20 Nov 2019 12:09:03 -0500 Subject: [PATCH] Documentation: correct and expand the markdown instructions for a link (#2106) * correcting and expanding the markdown instructions for a link - "some content" in `[some content](https://somelink/)` is called the content of an entity (or alt text for an image link) - "some title" in this example is the the title element of the entity: `[some content](https://somelink/ "some title")` * link description: Fixed a typo, restructured a line break I screwed up, and I cleaned up the language a bit --- readme/markdown.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme/markdown.md b/readme/markdown.md index 5ea314d471..4af17c31fa 100644 --- a/readme/markdown.md +++ b/readme/markdown.md @@ -21,7 +21,7 @@ This is a quick summary of the Markdown syntax. | **Inline code** | 
This is \`someJavaScript()\`
| This is `someJavaScript()` | **Code block** | 
Here's some JavaScript code:

\`\`\`
function hello() {
    alert('hello');
}
\`\`\`

Language is normally auto-detected,
but it can also be specified:

\`\`\`sql
SELECT * FROM users;
DELETE FROM sessions;
\`\`\`
| Here's some JavaScript code:

function hello() {
    alert('hello');
}

Language is normally auto-detected, but it can also be specified:

SELECT * FROM users;
DELETE FROM sessions;
| **Unformatted text** | 
Indent with a tab or 4 spaces
for unformatted text.

    This text will not be formatted:

    Robert'); DROP TABLE students;--
| Indent with a tab or 4 spaces for unformatted text.

This text will not be formatted:

Robert'); DROP TABLE students;--
-| **Link** | 
This is detected as a link:

`https://joplinapp.org`

And this is a link with a title:

`[Joplin](https://joplinapp.org)`
| This is detected as a link:

https://joplinapp.org

And this is a link with a title:

[Joplin](https://joplinapp.org) +| **Link** | 
This is detected as a link:

`https://joplinapp.org`

And this is a link anchoring text content:

`[Joplin](https://joplinapp.org)`

And this is a link, with a title,
anchoring text content:

`[Joplin](https://joplinapp.org "Joplin project page")`
| This is detected as a link:

https://joplinapp.org

And this is a link anchoring text content:

[Joplin](https://joplinapp.org)

And this is a link, with a title,
anchoring text content:

[Joplin](https://joplinapp.org "Joplin project page") (_hint: hover over the link_) | **Images** | 
`![Joplin icon](https://git.io/JenGk)`
| ![Here's Joplin icon](https://git.io/JenGk) | **Horizontal Rule** | 
One rule:
\*\*\*
Another rule:
\-\-\-
| One rule:

Another rule:
| **Tables** | [See below](#tables) |