Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Render the example helpful tip properly. #1586

Merged
merged 2 commits into from
Aug 24, 2020
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions docs/contributing/docs_style_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,20 @@
- Use `-` instead of `*` for bulleted lists.
- Upload images to the 'assets' folder and reference them from there.
-- For file name, use underscores between words and prefix all file names with the page name, e.g. context_display_hints.jpg for the image showing how to set display hints in the context menu.
- Use `!!! note "Note title"` at the start of a paragraph to have it rendered as a note like this:
- Use the [Admonition syntax](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) to create notes like this:

_Example:_

```
!!! note "Helpful Tip"
I am a helpful tip!
whikloj marked this conversation as resolved.
Show resolved Hide resolved
```

_Result:_

!!! note "Helpful Tip"
I am a helpful tip!
whikloj marked this conversation as resolved.
Show resolved Hide resolved

!!! note "Helpful Tip" I am a helpful tip!

## Don'ts

Expand Down