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.

Sign up for GitHub

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

Jump to bottom

Update docs_style_guide.md #1378

Merged
merged 4 commits into from
Dec 6, 2019
Merged

Update docs_style_guide.md #1378

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a57c1d8
Update docs_style_guide.md
manez Dec 3, 2019
35717ba
Update docs_style_guide.md
manez Dec 4, 2019
865c600
Merge branch 'master' into manez-style
manez Dec 4, 2019
f67f852
Merge branch 'master' into manez-style
manez Dec 6, 2019
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
2 changes: 1 addition & 1 deletion docs/contributing/docs_style_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. Done!


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

## Don'ts

Expand Down