markdown writing style (after finishing)

markdown writing style (after finishing)

Markdown is a text markup language created by John Gruber in 2004 to allow people to write documents in an "intuitive, easy-to-read plain text format".

1. Specifications on the layout

title

Titles are divided into four levels.
First-level heading: the title of the article Second-
level heading: the main title of the article
Third-level heading: a subtitle one level below the second-level
heading

• (1) The title filled in Github issues is h1, so the first-level title should not appear in the text.
• (2) The levels are chaotic and the structure is unclear, and titles cannot be used across levels (headings other than the four levels above are not used).
• (3) The parentheses should be output using the Chinese input method.
• (4) Reference links should be set to secondary headings.
• Recommendation: If there is parallel content under the third-level heading, it is recommended to use only the item list (Item list).

paragraph

A paragraph can only have one topic, or one central sentence.
The central sentence of the paragraph is placed at the beginning of the paragraph, giving an overview of the entire paragraph. The sentences stated later serve the core sentence.
The length of a paragraph cannot exceed seven lines, and the optimal paragraph length is less than or equal to four lines.
The sentence tone of the paragraph should be declarative and affirmative, and avoid exclamations.
Use a blank line between paragraphs.
Do not leave blank characters at the beginning of paragraphs.

• (1) Blank lines should be used to separate paragraphs from each other, and keeping the interval helps to read beautifully.
• (2) The beginning of the paragraph is not filled with indented characters, which is unified with the English article and is also easy to input.
• (3) The connection between the central sentence at the beginning of the paragraph and other sentences in the paragraph, from total to points.
• (4) The paragraph length should preferably be less than or equal to four lines.
• (5) The end of the article (End) character announces the end of the article

quote

• Reprint the whole article, indicate the author and source at a prominent position at the beginning of the full article, and link to the original text.
• When citing third-party content, the source should be indicated.
• When using external images, the source must be indicated below the image or at the end of the text.

2. Specifications on elements

2.1 Title

GitHub GFM specification supports ATX title and Setext title specification, ATX title specification is recommended, and supports up to 6 titles.

• The ATX header specification is recommended

2.2 Blank line

• no extra blank lines

  In Markdown text, to achieve true line breaks after rendering, it is usually to use two spaces plus a carriage return and line feed (under Unix, only carriage return CR), or rudely empty a line, but please do not empty two or more lines in a row.

• Empty line at end of file

  Empty lines at the end of files are strongly recommended, and most format checking tools will check for empty lines at the end of files. The possible reason for adding a blank line at the end of the file is to facilitate file splicing.

• Blank line before and after title

2.3 Space

• Spaces need to be added between Chinese and English
• Spaces need to be added between Chinese and numbers
• Spaces need to be added between numbers and units
• No space between full-width punctuation and other characters

2.4 Punctuation

• (1) A full-width period (.) should be used at the end of a Chinese sentence.
• (2) Pay attention to avoid "one amuse to the end", and use periods reasonably to separate the meaning of paragraphs.
• (3) For supplementary explanations, use full-width parentheses (()) without spaces before and after the parentheses.
• (4) All punctuation marks must be output using the Chinese input method.
• Do not reuse punctuation marks

2.5 Full-width and half-width

• Use full-width Chinese punctuation
• Numbers use half-width characters
• When encountering complete English sentences and special nouns, use half-width punctuation.

2.6 Noun

• Use proper capitalization for proper nouns
• Don't use inappropriate abbreviations

2.7 Others

• Add spaces between links

• Bold, italic, and highlighted text with spaces before and after

  It is recommended to add spaces before and after bold, italic, and highlighted text, otherwise format parsing will fail in some cases.

  Suggested usage:

  Fixed a memory leak introduced by someone in version v0.1.1.
  Test text, this is the test.

• List indent

  It is recommended to use 4 spaces for text indentation, especially when encountering ordered or unordered lists. In addition, when using an unordered list or an ordered list, it is recommended to leave a blank line between the upper and lower levels, and no blank line between the same level.

• / usage of

  Spaces before and after the / character are recommended, except when used as path descriptors.

• Simplified Chinese use right angle quotation marks

  usage:

  "Teacher, what does the word "orderly" mean?"

  Contrast usage:

  "Teacher, what does 'orderly' mean?"