Attention Signs
Sat Jan 11 2025

Speed Bump

People skim through documentation. You can grab users attention by using attention signs.
To create an attention sign, start a paragraph with one of the predefined keywords followed by a colon.
Keyword: message

Note

Note: It is very important to not overuse signs. Make sure each sign counts.
Note:It is very important to not overuse signs. Make sure each sign counts.

Warning

Warning: Bring attention to a common mistake or an often missed configuration step 
using a warning sign. Do not use too many warning signs.
Warning:Bring attention to a common mistake or an often missed configuration step using a warning sign. Do not use too many warning signs.

Question

Question: Use the question sign to bring an extra attention to the main idea of a page.
\
What is the point of the `attention signs`?
Question:Use the question sign to bring extra attention to the main idea of a page.
What is the point of the attention signs?

Exercise

Exercise: write a hello world example in this language
Exercise:write a hello world example in this language

Avoid

Avoid: using multiple versions of `ReactJS` inside one project.
Avoid:using multiple versions of ReactJS inside one project.

Do Not

Don't: commit node_modules to your repository

Do not: commit node_modules to your repository
Don't:commit node_modules to your repository
Do not:commit node_modules to your repository

Tip

Tip: use temporary directory to generate the summary file for upload
Tip:use temporary directory to generate the summary file for upload

Recommendation

Recommendation: write automated tests for new business logic
Recommendation:write automated tests for new business logic

Fence Block

Use fence block to create an explicit attention block.
```attention-note
hello world
```
hello world
By default, there is only icon. Use label to add text
```attention-note {label: "Custom Label"}
hello world
```
Custom Label:
hello world
Using block makes it easier to include other plugins inside
`````attention-note
Use this command to setup fresh environment
```cli
mycommand setup
```
`````
Use this command to setup fresh environment
$ 
mycommand setup

Attention Block Types

attention-<type>
note
warning
avoid
question
recommendation