Markdown and LaTeX writing specifications (continuously updated, recommended collection)

Markdown and LaTeX Writing Guidelines

In fact, when I wrote this title, it was not standardized, because the LaTeX standard way of writing is $\text{LATEX}$ , but I still write it as LaTeX, because it is convenient for SEO search optimization, and readers can also find this blog if they search for wrong keywords.

The following introduces some of the writing norms and some skills that I have summarized that should be paid attention to in writing. The following specifications only represent personal opinions. If you have any opinions, please hold back. Resistance is invalid.

General Writing Guidelines

I have been learning Chinese since I was a child, but unfortunately, many people cannot write correctly and standardizedly. For example, 99.99% of people lack punctuation in WeChat chat because they find it troublesome or too rigid. Over time, they lose the ability to use punctuation correctly.

word spacing

• A space should be added between English characters, numbers, mathematical formulas and Chinese characters.
  I was born on July 6, 1994. My English name is Rockson. I don’t know what $Alpha$ particles. ❌I
  was born on July 6, 1994, my English name is Rockson, I don’t know what$Alpha$ particles. ✅

• There should be no spaces between English characters, numbers, mathematical formulas and Chinese punctuation.
  I am little Y, my favorite number is 8, and the most hated Greek letter is $\delta$ . ❌I
  am little Y, my favorite number is 8, and the most hated Greek letter is$d$ . ✅

• Writing in English, add spaces after commas and periods.
  I am from Fujian province,southeast of China.Welcome to my home.❌I
  am from Fujian province,southeast of China.Welcome to my home.✅

• For articles in Chinese, try to write Chinese punctuation, and don’t write it into English.
  Today is destined to be an extraordinary day, three social products are launched at the same time. ❌Today
  is destined to be an extraordinary day, three social products are launched at the same time. ✅

• Correct use of quotation marks: When a person says a complete sentence, a period should be placed inside the quotation marks; if the content of the quotation marks is the subject and object, no period should be added inside the quotation marks.
  Maugham said: "Reading is a refuge that you take with you." （后面没有任何标点符号)✅
  "Reading is a refuge that you take with you." Maugham said. ✅
  Maugham said that "reading is a refuge that you carry with you". ✅
  "Reading is a portable refuge" is Maugham's famous saying. ✅

• Book titles are used consecutively without a comma in between.
  "Statistical Learning Methods", "Machine Learning" and "Deep Learning" are must-read books for our introductory AI. ❌
  "Statistical Learning Methods", "Machine Learning" and "Deep Learning" are must-read books for us to get started with AI. ✅

• English book titles, movie titles, song titles, and game titles need to be italicized. Chinese book title, movie title, song title, game title plus book title.
  The Definitive Guide to Java Performance ✅
  "The Definitive Guide to Java Performance" ✅

• Remarks in Chinese and English, when the English names of some books, movies, games, etc. are given in the article, if the books, movies, games, etc.
  have Chinese versions, then we should mention the Chinese version and add brackets. When writing Chinese articles, if the technical terms are translated from English by yourself, it is not so conventional, and the original English name needs to be marked.
  Knuth's "The Art of Computer Programming" ( The Art of Computer Programming ) is an immortal masterpiece in the field of computers. ✅Knuth
  's The Art of Computer Programming (Chinese version of "Computer Programming Art") is an immortal masterpiece in the computer field. ✅

• Use titles correctly. For sub-statements after the colon, a title is generally used in the middle, and a period is used at the end.

The Correct Use of "Di De"

• adjective $+$ for nouns的. Example: beautiful girl
• verb $+$ used to modify adverbs得 . Example: run fast
• adverb $+$ Verbs are used地. Example: readily agree

correct use of nouns

Many names need to pay attention to the official standard writing, such as capitalization. Here are some error-prone names: Java, GitHub, Node.js, Python, C/C++, MySQL, SQL, LaTeX \ $\text{LATEX}$、 Markdown、MATLAB…

standard math notation

Please use standard math notation for formulas, symbols, etc.:

• Italics for single letters are used to denote mathematical constants , variables , and unknowns .
• Numbers, operators, and punctuation marks, as well as commonly defined functions or abbreviations, use upright roman font, e.g. $\cos$、$\mathrm{let}$、$e$ or$\exp$、$\lim$、$\log$、$\max$、$\min$、$\sin$、$\tan$、$d$ (for derivative). It is wrong to write the following:
  $$cos,det,e,exp,lim,log,max,min,sin,tan,dInfact$$
  , most of these will display correctly as long as they are preceded by a$$slash$$ .
• Bold indicates vectors, tensors, and matrices.

Proper use of non-"normal" elements

General editors or things that come with them are called normal elements, and abnormal elements are things that are copied from other places and make your documents or PPTs fancy. For example, the principle that PPT should follow is to make the introduction beautiful, refer to: https://blog.csdn.net/lusongno1/article/details/72886309

Some non-"normal" elements can be added reasonably and appropriately, such as the Emoji expression in the document. The reasonable and appropriate emphasis here can express the expression, otherwise, please don't add it randomly. It's full of Emoji, it's so gaudy, it's extremely nauseating.

Here are some websites where you can use Emoji expressions. I copied the two symbols above from them, so use them with caution.

https://ld246.com/emoji/index.html?tdsourcetag=s_pctim_aiomsg
https://www.emojicopy.com/
https://gitmoji.dev/
https://getemoji.com/
https://www.webfx.com/tools/emoji-cheat-sheet/
https://www.emojidaquan.com/

copyright awareness

Last but not least, any form of creation (including PPT, Beamer, etc.), please respect originality. Please indicate the source of non-original pictures, flowcharts or other file data. Please indicate the referenced documents in the article, and indicate the source in the references at the end.

$\text{LATEX}$ topic

In order to more easily meet the above writing norms, here will continue to add some $\text{LATE}$Tips for$\text{X writing, continuously updated, bookmarkable.}$Here is just one example, for more content, refer to:

https://blog.csdn.net/lusongno1/article/details/81106251

new definition and redefinition

It is mentioned above that characters should be used in a standardized way, but in fact, there are some characters, such as the derivation symbol $d$ , many people often write it as$d$ . In general, formax ⁡ \maxSuch \maxas$max\; can\; be\; expressed\; directly\; by\; writing.$However, in$\text{TE}$In the$\text{X}$\d system, it is used to express the accent mark. At this time, we can define it. The usage of the definition is as follows:

\newcommand{\hu}{\hat u}
\newcommand{\d}{\mathrm{d}}
\newcommand{\vct[1]}{\boldsymbol{#1}}
\newcommand{\comment[1]}{
   
   {\color{blue}{#1}}}

It is very simple, that is \newcommand{新命令}{指代的命令}, \newcommandfollowed by two braces, the first brace writes the command form of the definition, and the second brace writes the meaning expressed by the command. Braces can be omitted if there is no confusion. When the defined command needs to provide parameters, add after the command we defined [数字]to indicate number of parameters that this command needs to provide, and #数字序号the format used in the subsequent analysis indicates the number of inputs to operate.