Common pitfalls

Here we describe some common mistakes. Read this section before you start in order to avoid common errors.

Tip

If you use an IDE with good reStructuredText support, it should point out these errors correctly, for example if you use PhpStorm, enable the reStructuredText plugin.

• Problems with headers
  • Correct syntax
  • Wrong syntax
  • Additional information
• Problems with links
  • Correct syntax
  • Common mistake #1: Missing space
  • Common mistake #2: Missing underscore (_)
  • Additional information
• Problems with indents
  • Common mistake #1: Incorrect indents
• Problems with inline style
  • Correct syntax
  • Wrong syntax
• Problems with lists
  • Correct syntax
  • Additional information