Markdown Summary

Markdown  is a lightweight markup language that allows people to use and easy to read, easy to write a document written in plain text format. Markdown language need rendered to the editor showing a variety of good form.

Markdown usage scenarios:

When you format your article is nothing special needs, and do not want to spend too much time on the layout, you can use Markdown. Because the editor or the platform will be rendered by Markdown article mark, the final effect will be very simple layout, beautiful.

 

Markdown title:

Title Recommendations syntax:

# + Space + Title Content

Syntax is as follows:

  • # Beginning of the line inserted to mark the title.
  • The number # indicates the level of the title.
  • It proposes to add a space after #.
  • Markdown supports only up before six titles, similar to HTML in h1 ~ h6.

Title specification as follows:

1 ) recommended # title tag, rather than === --- or
 2 ) to maintain spacing, before and after the recommended title to be empty 1 line (unless the title in the beginning of the document); also there is between # 1 and title text spaces
 3 ) do not have extra spaces. Suggested that the title be written in the beginning of a line, the end does not have a space.
4 ) suggested that the title is not the end of punctuation, such as periods, commas, colons, semicolons, and so on.
5 ) suggested that the title be as brief as possible, so ease of reference, especially when the build directory. If the title was originally drafted by a long sentence, the title can be extracted from a long sentence, but as a long sentence under the heading.
Written using Markdown document more recommended structure is as follows:
# Document Title 

Author 

Abstract 

Contents 

## Title 1 

### Title 1.1 

## Heading 2 

### 2. The title of 1 

### 2. The title of 2

described as follows:

  • Document title: The first title of the document should be a title, written in the first row, we recommend the same file name, title to be as brief as possible.
  • Author: optional, the author has declared for the document, if the document is an open source project, suggested that the author's name written in the revision history.
  • Abstract: The core of 1-3 sentence description of the document.
  • Contents: For a quick overview of the document structure, easy navigation.
  • Body: the body of the title from the beginning of secondary directory, progressively increased, not skip a grade, not the same.

 

Markdown bold and italic:

In  Markdown  in bold (bold) from two  or two  parcels, one of italics  or a  package.

Example:

** bold ** 
__ __ bold

 * italics * 
_ italic _

Use bold and italic:

1 ) * recommended bold use of two parcels, wrapped in italics using a *, * because more common, and more than _ more readable.
2 ) inside the bold and italic Syntax Notation One, it is recommended not to have spaces.

 

Markdown paragraph and line feed:

Markdown  paragraph of text consisting of one or more lines, blank lines between paragraphs different labeled.

Syntax is as follows:

  • If there is no blank line between lines, it will be considered in the same paragraph.
  • If there are empty rows between lines, it will be treated as separate paragraphs.
  • A row is empty inline nothing or only spaces and tabs.
  • If you want to change the line segment, the need to insert more than two spaces at the end of the previous line and press Enter.

Examples are as follows:

And a line feed passages specification:

For ease of reading, should limit the number of characters per line, each line is usually not more than 80 characters can be set in the editor.

About newline, the following recommendations:

  • After more than 80 characters wrap.
  • After the sentence end (period, exclamation mark or question mark) wrap.
  • When a long URL wrapping.

URL usually longer lead to the number of lines of characters exceeds the limit, in order to improve readability, you can add a line break before the URL (\ n), as follows:

Hello, everyone, for everyone to recommend a good Python tutorial: 
[Python based tutorial, Getting Started with Python Tutorial (very detailed)] (HTTP: //c.biancheng.net/python/)

Or be optimized by reference links:

Hello, everyone, for everyone to recommend a good Python tutorial: [Python based tutorial, Getting Started with Python Tutorial (very detailed)] 

[Python based tutorial, Getting Started with Python Tutorial (very detailed)]: HTTP: //c.biancheng.net/ python /

 

Markdown list:

Markdown  supports ordered list and unordered list, similar to HTML in the <ul> and <ol> tag.

Ordered list syntax is as follows:

Numbering periods + + space + content list

Unordered list syntax is as follows:

* / + / - + space +   contents of the list 

to use *, +, - to mark the effect of unordered list is the same.

 

Nested list:

List of nested syntax:

+ The first layer listing 
the TAB + second layer listing 
the TAB + + third layer listing the TAB

The syntax is described below.

  • The list can be nested list.
  • Ordered list and unordered lists can also be nested to each other.

Use the list:

1) is recommended - to mark the unordered list, because * easy to confuse with bold and italic, and + unpopular.
2) If a list of all the list items are no line breaks, we recommend using a 1 spaces. (Among a list of items and a list of identification)
 3) If there is a list of items wrap, it is recommended to use three spaces unordered list, ordered list to use two spaces. (Between list items and list identifies)
 4) If a list of each item in the list are only one line, do not have blank lines between the recommended list items.
5) If there is a list item wrap is recommended between the empty list item 1 line, so it will be easier to distinguish multiple lines start and end of the list.
6) recommendations 1 empty line in the list before / after.

 

Examples are as follows:

# List of 

## ordered list 

1 C language Chinese network.
 2 Markdown tutorial.
 3 HTTP:. // c.biancheng.net/markdown/ 

## unordered list

 - use [minus sign] identifies unordered list
 - use [Less number] identifies the unordered list 

## nested list

 - I was the first layer of the list
     - I was the second layer list
         - I was third layer list
             - my list is the fourth layer 

## ordered list and unordered lists each inlay sets 

1 . I am the first layer of the list
     - I was the second layer list
         1 I am a third layer list.
         2 I am a third layer of a list of two.

 - C language Getting Started tutorial
 - HTTP: // c.biancheng.net/ c /
 
-    C language Getting Started tutorial
 - http:// c.biancheng.net/c/
 
-    this list 
    has line feed
 -    this is no line breaks 

1 . The ordered list 
    has a wrap 
2 . This does not wrap

 - Markdown Tutorial: HTTP: // c.biancheng.net/markdown/ 
- Python tutorial: HTTP: // c.biancheng.net/python/ 
- the Java tutorial: HTTP: // c.biancheng.net/java/
 
-    Markdown tutorial: 
    HTTP: // c.biancheng.net/markdown/
 
-    Python tutorial: 
    HTTP: // c.biancheng.net/python/
 
-    the Java tutorial: 
    HTTP: // c.biancheng.net/java/

 

markdown underlined:

In  Markdown  , the dividing line of three or more *or _marked. _It is underlined, rather than a minus.

The syntax is as follows:

First line
 *** 
The second line content 
___ 
third line

 

Syntax:

  • Shall be used parting line of at least 3 *or _marked.
  • You can not have the other characters in the identifier of the line.
  • Tag can be added in the intermediate space.

Examples are as follows:

## asterisk as the dividing line 

of the first row of content
 *** 
a second row of content   
ha
 * * *  
third line
 ******** 

## underscores the dividing line 

of the first row of content 
___ 
second row of content 
_ _ _ 
third line 
_______

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

aaa

Guess you like

Origin www.cnblogs.com/neozheng/p/12110154.html