Fossil SCM
Improve built-in Markdown reference documentation to describe more features I long wished Markdown had but just now discovered it already does
Commit
3bfdafe4aa552d3ce24469938d72c788873ccf93c2683f89f9640e18f15b940a
Parent
23d45ff9ce35a77…
1 file changed
+41
-18
+41
-18
| --- src/markdown.md | ||
| +++ src/markdown.md | ||
| @@ -1,71 +1,94 @@ | ||
| 1 | 1 | # Markdown Overview # |
| 2 | 2 | |
| 3 | 3 | ## Paragraphs ## |
| 4 | 4 | |
| 5 | -> Paragraphs are divided by blank lines. | |
| 5 | +> Paragraphs are divided by blank lines. | |
| 6 | +> End a line with two or more spaces to force a mid-paragraph line break. | |
| 6 | 7 | |
| 7 | 8 | ## Headings ## |
| 8 | 9 | |
| 9 | 10 | > |
| 10 | 11 | # Top-level Heading Alternative Top Level Heading |
| 11 | - ============================= | |
| 12 | + # Top-level Heading Variant # ============================= | |
| 12 | 13 | > |
| 13 | 14 | ## Second-level Heading Alternative 2nd Level Heading |
| 14 | - ----------------------------- | |
| 15 | + ## Second-level Heading Variant ## ----------------------------- | |
| 15 | 16 | |
| 16 | 17 | ## Links ## |
| 17 | 18 | |
| 18 | 19 | > 1. **\[display text\]\(URL\)** |
| 19 | 20 | > 2. **\[display text\]\(URL "Title"\)** |
| 20 | -> 3. **\<URL\>** | |
| 21 | -> 4. **\[display text\]\[label\]** | |
| 21 | +> 3. **\[display text\]\(URL 'Title'\)** | |
| 22 | +> 4. **\<URL\>** | |
| 23 | +> 5. **\[display text\]\[label\]** | |
| 24 | +> 6. **\[display text\]\[\]** | |
| 25 | + | |
| 26 | +> **URL** may optionally be written **\<URL\>**. With link formats 5 and 6 | |
| 27 | +> ("reference links"), the URL is supplied elsewhere in the document, as shown | |
| 28 | +> below. Link format 6 reuses the display text as the label. Labels are | |
| 29 | +> case-insensitive. The title may be split onto the next line with optional | |
| 30 | +> indenting. | |
| 22 | 31 | |
| 23 | -> With link format 4 ("reference links") the label must be resolved by | |
| 24 | -> including a line of the form **\[label\]: URL** or | |
| 25 | -> **\[label\]: URL "Title"** somewhere else | |
| 26 | -> in the document. | |
| 32 | +> * **\[label\]: URL** | |
| 33 | +> * **\[label\]: URL "Title"** | |
| 34 | +> * **\[label\]: URL 'Title'** | |
| 35 | +> * **\[label\]: URL (Title)** | |
| 27 | 36 | |
| 28 | 37 | ## Fonts ## |
| 29 | 38 | |
| 30 | 39 | > * _\*italic\*_ |
| 31 | 40 | > * *\_italic\_* |
| 32 | 41 | > * __\*\*bold\*\*__ |
| 33 | 42 | > * **\_\_bold\_\_** |
| 34 | -> * `` `code` `` | |
| 43 | +> * \``code`\` | |
| 35 | 44 | |
| 36 | -> Note that the \`...\` construct disables HTML markup, so one can write, | |
| 37 | -> for example, **\``<html>`\`** to yield **`<html>`**. | |
| 45 | +> The **\`code\`** construct disables HTML markup, so one can write, for | |
| 46 | +> example, **\`\<html\>\`** to yield **`<html>`**. | |
| 38 | 47 | |
| 39 | 48 | ## Lists ## |
| 40 | 49 | |
| 41 | 50 | > |
| 42 | 51 | * bullet item |
| 43 | 52 | + bullet item |
| 44 | 53 | - bullet item |
| 45 | 54 | 1. numbered item |
| 46 | 55 | |
| 56 | +> A two-level list is created by placing additional whitespace before the | |
| 57 | +> **\***/**+**/**-**/**1.** of the secondary items. | |
| 58 | + | |
| 59 | +> | |
| 60 | + * top-level item | |
| 61 | + * secondary item | |
| 62 | + | |
| 47 | 63 | ## Block Quotes ## |
| 48 | 64 | |
| 49 | -> Begin each line of a paragraph with ">" to block quote that paragraph. | |
| 65 | +> Begin each line of a paragraph with **>** to block quote that paragraph. | |
| 50 | 66 | |
| 51 | 67 | > > |
| 52 | 68 | > This paragraph is indented |
| 53 | 69 | > > |
| 54 | 70 | > > Double-indented paragraph |
| 71 | + | |
| 72 | +> Begin each line with at least four spaces or one tab to produce a verbatim | |
| 73 | +> code block. | |
| 55 | 74 | |
| 56 | 75 | ## Miscellaneous ## |
| 57 | 76 | |
| 58 | -> * In-line images using **\!\[alt-text\]\(image-URL\)** | |
| 59 | -> * Use HTML for complex formatting issues. | |
| 77 | +> * In-line images are made using **\!\[alt-text\]\(image-URL\)**. | |
| 78 | +> * Use HTML for complex formatting such as tables and forms. | |
| 60 | 79 | > * Escape special characters (ex: "\[", "\(", "\*") |
| 61 | 80 | > using backslash (ex: "\\\[", "\\\(", "\\\*"). |
| 62 | -> * See [daringfireball.net](http://daringfireball.net/projects/markdown/syntax) | |
| 63 | -> for additional information. | |
| 81 | +> * A line consisting of **---**, **\*\*\***, or **\_\_\_** is a horizontal | |
| 82 | +> rule. Spaces and extra **-**/**\***/**_** are allowed. | |
| 83 | +> * See [daringfireball.net][] for additional information. | |
| 84 | +> * See this page's [Markdown source](/md_rules?txt=1) for more examples. | |
| 64 | 85 | |
| 65 | 86 | ## Special Features For Fossil ## |
| 66 | 87 | |
| 67 | 88 | > * In hyperlinks, if the URL begins with "/" then the root of the Fossil |
| 68 | 89 | > repository is prepended. This allows for repository-relative hyperlinks. |
| 69 | -> * For documents that begin with top-level heading (ex: "# heading #"), the | |
| 90 | +> * For documents that begin with a top-level heading (ex: "# heading #"), the | |
| 70 | 91 | > heading is omitted from the body of the document and becomes the document |
| 71 | 92 | > title displayed at the top of the Fossil page. |
| 93 | + | |
| 94 | +[daringfireball.net]: http://daringfireball.net/projects/markdown/syntax | |
| 72 | 95 |
| --- src/markdown.md | |
| +++ src/markdown.md | |
| @@ -1,71 +1,94 @@ | |
| 1 | # Markdown Overview # |
| 2 | |
| 3 | ## Paragraphs ## |
| 4 | |
| 5 | > Paragraphs are divided by blank lines. |
| 6 | |
| 7 | ## Headings ## |
| 8 | |
| 9 | > |
| 10 | # Top-level Heading Alternative Top Level Heading |
| 11 | ============================= |
| 12 | > |
| 13 | ## Second-level Heading Alternative 2nd Level Heading |
| 14 | ----------------------------- |
| 15 | |
| 16 | ## Links ## |
| 17 | |
| 18 | > 1. **\[display text\]\(URL\)** |
| 19 | > 2. **\[display text\]\(URL "Title"\)** |
| 20 | > 3. **\<URL\>** |
| 21 | > 4. **\[display text\]\[label\]** |
| 22 | |
| 23 | > With link format 4 ("reference links") the label must be resolved by |
| 24 | > including a line of the form **\[label\]: URL** or |
| 25 | > **\[label\]: URL "Title"** somewhere else |
| 26 | > in the document. |
| 27 | |
| 28 | ## Fonts ## |
| 29 | |
| 30 | > * _\*italic\*_ |
| 31 | > * *\_italic\_* |
| 32 | > * __\*\*bold\*\*__ |
| 33 | > * **\_\_bold\_\_** |
| 34 | > * `` `code` `` |
| 35 | |
| 36 | > Note that the \`...\` construct disables HTML markup, so one can write, |
| 37 | > for example, **\``<html>`\`** to yield **`<html>`**. |
| 38 | |
| 39 | ## Lists ## |
| 40 | |
| 41 | > |
| 42 | * bullet item |
| 43 | + bullet item |
| 44 | - bullet item |
| 45 | 1. numbered item |
| 46 | |
| 47 | ## Block Quotes ## |
| 48 | |
| 49 | > Begin each line of a paragraph with ">" to block quote that paragraph. |
| 50 | |
| 51 | > > |
| 52 | > This paragraph is indented |
| 53 | > > |
| 54 | > > Double-indented paragraph |
| 55 | |
| 56 | ## Miscellaneous ## |
| 57 | |
| 58 | > * In-line images using **\!\[alt-text\]\(image-URL\)** |
| 59 | > * Use HTML for complex formatting issues. |
| 60 | > * Escape special characters (ex: "\[", "\(", "\*") |
| 61 | > using backslash (ex: "\\\[", "\\\(", "\\\*"). |
| 62 | > * See [daringfireball.net](http://daringfireball.net/projects/markdown/syntax) |
| 63 | > for additional information. |
| 64 | |
| 65 | ## Special Features For Fossil ## |
| 66 | |
| 67 | > * In hyperlinks, if the URL begins with "/" then the root of the Fossil |
| 68 | > repository is prepended. This allows for repository-relative hyperlinks. |
| 69 | > * For documents that begin with top-level heading (ex: "# heading #"), the |
| 70 | > heading is omitted from the body of the document and becomes the document |
| 71 | > title displayed at the top of the Fossil page. |
| 72 |
| --- src/markdown.md | |
| +++ src/markdown.md | |
| @@ -1,71 +1,94 @@ | |
| 1 | # Markdown Overview # |
| 2 | |
| 3 | ## Paragraphs ## |
| 4 | |
| 5 | > Paragraphs are divided by blank lines. |
| 6 | > End a line with two or more spaces to force a mid-paragraph line break. |
| 7 | |
| 8 | ## Headings ## |
| 9 | |
| 10 | > |
| 11 | # Top-level Heading Alternative Top Level Heading |
| 12 | # Top-level Heading Variant # ============================= |
| 13 | > |
| 14 | ## Second-level Heading Alternative 2nd Level Heading |
| 15 | ## Second-level Heading Variant ## ----------------------------- |
| 16 | |
| 17 | ## Links ## |
| 18 | |
| 19 | > 1. **\[display text\]\(URL\)** |
| 20 | > 2. **\[display text\]\(URL "Title"\)** |
| 21 | > 3. **\[display text\]\(URL 'Title'\)** |
| 22 | > 4. **\<URL\>** |
| 23 | > 5. **\[display text\]\[label\]** |
| 24 | > 6. **\[display text\]\[\]** |
| 25 | |
| 26 | > **URL** may optionally be written **\<URL\>**. With link formats 5 and 6 |
| 27 | > ("reference links"), the URL is supplied elsewhere in the document, as shown |
| 28 | > below. Link format 6 reuses the display text as the label. Labels are |
| 29 | > case-insensitive. The title may be split onto the next line with optional |
| 30 | > indenting. |
| 31 | |
| 32 | > * **\[label\]: URL** |
| 33 | > * **\[label\]: URL "Title"** |
| 34 | > * **\[label\]: URL 'Title'** |
| 35 | > * **\[label\]: URL (Title)** |
| 36 | |
| 37 | ## Fonts ## |
| 38 | |
| 39 | > * _\*italic\*_ |
| 40 | > * *\_italic\_* |
| 41 | > * __\*\*bold\*\*__ |
| 42 | > * **\_\_bold\_\_** |
| 43 | > * \``code`\` |
| 44 | |
| 45 | > The **\`code\`** construct disables HTML markup, so one can write, for |
| 46 | > example, **\`\<html\>\`** to yield **`<html>`**. |
| 47 | |
| 48 | ## Lists ## |
| 49 | |
| 50 | > |
| 51 | * bullet item |
| 52 | + bullet item |
| 53 | - bullet item |
| 54 | 1. numbered item |
| 55 | |
| 56 | > A two-level list is created by placing additional whitespace before the |
| 57 | > **\***/**+**/**-**/**1.** of the secondary items. |
| 58 | |
| 59 | > |
| 60 | * top-level item |
| 61 | * secondary item |
| 62 | |
| 63 | ## Block Quotes ## |
| 64 | |
| 65 | > Begin each line of a paragraph with **>** to block quote that paragraph. |
| 66 | |
| 67 | > > |
| 68 | > This paragraph is indented |
| 69 | > > |
| 70 | > > Double-indented paragraph |
| 71 | |
| 72 | > Begin each line with at least four spaces or one tab to produce a verbatim |
| 73 | > code block. |
| 74 | |
| 75 | ## Miscellaneous ## |
| 76 | |
| 77 | > * In-line images are made using **\!\[alt-text\]\(image-URL\)**. |
| 78 | > * Use HTML for complex formatting such as tables and forms. |
| 79 | > * Escape special characters (ex: "\[", "\(", "\*") |
| 80 | > using backslash (ex: "\\\[", "\\\(", "\\\*"). |
| 81 | > * A line consisting of **---**, **\*\*\***, or **\_\_\_** is a horizontal |
| 82 | > rule. Spaces and extra **-**/**\***/**_** are allowed. |
| 83 | > * See [daringfireball.net][] for additional information. |
| 84 | > * See this page's [Markdown source](/md_rules?txt=1) for more examples. |
| 85 | |
| 86 | ## Special Features For Fossil ## |
| 87 | |
| 88 | > * In hyperlinks, if the URL begins with "/" then the root of the Fossil |
| 89 | > repository is prepended. This allows for repository-relative hyperlinks. |
| 90 | > * For documents that begin with a top-level heading (ex: "# heading #"), the |
| 91 | > heading is omitted from the body of the document and becomes the document |
| 92 | > title displayed at the top of the Fossil page. |
| 93 | |
| 94 | [daringfireball.net]: http://daringfireball.net/projects/markdown/syntax |
| 95 |