Skip to content

Commit

Permalink
Render the example helpful tip properly. (Islandora#1586)
Browse files Browse the repository at this point in the history
* Render the example helpful tip properly.

* Fix note syntax, again.
  • Loading branch information
rosiel committed Sep 9, 2020
1 parent a4bf86b commit 4ce6959
Showing 1 changed file with 13 additions and 2 deletions.
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 (four-space indent required):

_Example:_

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

_Result:_

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

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

## Don'ts

Expand Down

0 comments on commit 4ce6959

Please sign in to comment.