Update docs_style_guide.md #1378
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rosiel
approved these changes
Dec 3, 2019
whikloj
reviewed
Dec 4, 2019
| @@ -12,7 +12,7 @@ | |||
| -- 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` at the start of a paragraph to have it rendered as a note like this: | |||
There was a problem hiding this comment.
Maybe this should specify that you need to have a title, as it appears required. Also might be good to explictly display the note below.
Use
!!! "Note Title"at the start of a paragraph to have it rendered as a note like this:!!! "Helpful Tip" I am a helpful tip!
|
@manez your branch is out-of-date, could you update so we can merge. It is my arch-nemesis. |
|
@whikloj all up to date, I think? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
GitHub Issue: #1040
What does this Pull Request do?
Fixes the tip about how to make Tips so that it should actually render properly in the docs Right now, it's not.
What's new?
I think it needs a title to work properly.
How should this be tested?
run mkdocs on the docs and see if the tip presents as a nice blue box, as seen here
Interested parties
@Islandora/8-x-committers