Skip to content

Commit

Permalink
Rephrase Notes section and fix markdown (#996)
Browse files Browse the repository at this point in the history
I guess it is https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html?tabs=tabid-1%2Ctabid-a#note-warningtipimportant to blame for abstract self-contradictory samples with copy-paste artifacts.
  • Loading branch information
Maximusya authored and adamsitnik committed Jan 6, 2019
1 parent 299e1f4 commit 0da14b4
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/articles/contributing/documentation.md
Expand Up @@ -15,37 +15,37 @@ BenchmarkDotNet uses [DocFX](https://dotnet.github.io/docfx/) as a documentation

## Notes

DocFX uses the following syntax for different types of notes:
DocFX uses the [following syntax](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html?tabs=tabid-1%2Ctabid-a#note-warningtipimportant) inside block quote for different types of notes:

```markdown
> [!NOTE]
> <note content>
> note content
> [!TIP]
> <note content>
> tip content
> [!WARNING]
> <warning content>
> warning content
> [!IMPORTANT]
> <important content>
> important content
> [!Caution]
> <caution content>
> caution content
```

It will be transformed to:

> [!NOTE]
> <note content>
> note content
> [!TIP]
> <note content>
> tip content
> [!WARNING]
> <warning content>
> warning content
> [!IMPORTANT]
> <important content>
> important content
> [!Caution]
> <caution content>
> caution content
## Building documentation locally

Expand Down Expand Up @@ -78,4 +78,4 @@ Linux/macOS (Bash):

* [DocFX User Manual](https://dotnet.github.io/docfx/tutorial/docfx.exe_user_manual.html)
* [DocFX Tutorials: Links and Cross References](https://dotnet.github.io/docfx/tutorial/links_and_cross_references.html)
* [DocFX Flavored Markdown](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html?tabs=tabid-1%2Ctabid-a#file-inclusion)
* [DocFX Flavored Markdown](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html?tabs=tabid-1%2Ctabid-a#file-inclusion)

0 comments on commit 0da14b4

Please sign in to comment.