Skip to content

Commit 2f91b16

Browse files
committed
style(readme): improve formatting
1 parent 931148b commit 2f91b16

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,20 +41,19 @@ Instead, try to be more descriptive, for example:
4141
- For consistency, use **bold** to highlight UI text when dealing with UI-focused documentation (for example, Apify Console).
4242
- For consistency, use _italics_ to emphasize text.
4343
- For inline `code` examples, use **back-ticks** (\` \`).
44-
- For multi-line code examples, use code fences and specify the language. Preferably, specify the title as well.
45-
- Within platform documentation, always use [Code tabs](README.md#code-tabs) and declare the language.
44+
- For multi-line code examples, use code fences and specify the language. Preferably, specify the title as well. Within platform documentation, always use [Code tabs](README.md#code-tabs) and declare the language.
4645

47-
```markdown
48-
\`\`\`js showLineNumbers title='foo.js'
46+
```markdown
47+
\`\`\`js showLineNumbers title='foo.js'
4948

50-
const docsAreCool = require('coolDocs'); <br/>
51-
...<br/>
52-
return docsAreCool;<br/>
49+
const docsAreCool = require('coolDocs'); <br/>
50+
...<br/>
51+
return docsAreCool;<br/>
5352

54-
\`\`\`
55-
```
53+
\`\`\`
54+
```
5655

57-
Check out [Markdown features](https://docusaurus.io/docs/markdown-features) in the Docusaurus docs for more information.
56+
Check out [Markdown features](https://docusaurus.io/docs/markdown-features) in the Docusaurus docs for more information.
5857

5958
### Admonitions
6059

0 commit comments

Comments
 (0)