When we write an open source project, we often need to write a readme to let others briefly understand the operating environment of the project and the ideas adopted. Then how to write a good readme. GitHub has its own symbols for the title, text, and branch. , Code snippets, etc. The following symbols are commonly used:
1. ## (Note: the more #, the smaller the font size)
This symbol is used to generate a bold title font and a bottom line is generated at the same time. For example: ## Technology Stack:
Two, 1. `` `English` `
This symbol is used to display English and will generate a light gray background. For example:
2. ```javascript (note that this javascript is necessary, otherwise it will not be recognized as a code)
js code
```
Three,>
This symbol is used to generate vertical dividing lines. For example:
four,[]()
This is a combination symbol, where [] puts content () puts url, which is equivalent to a tag
For example: [Address is here](https://github.com/bailicangdu/vue2-elm)
Fives,![]()
This is also the combination symbol, which is used to display the picture, where () is the src address of the picture
For example:
6. **Content **
This symbol is used to indicate the subtitles, subtitles and other bold fonts in the article
such as:
**5 hook functions are triggered when the component is initialized:**
**1, getDefaultProps()**
> Set the default props, you can also use dufaultProps to set the default properties of the component.
Seven,-[x]
The effect of this symbol is to generate √
Well, the commonly used symbols are basically these few, I hope to help you!