Skip to content

Commit

Permalink
updated guidelines with special character issues
Browse files Browse the repository at this point in the history
  • Loading branch information
vikram-redhat committed Aug 1, 2018
1 parent 047f1ab commit 3f466dd
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions contributing_to_docs/doc_guidelines.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -592,6 +592,27 @@ some code block

. Item 3

=== Invalid formatting

The following are examples of invalid formatting and some resolutions.

*Problem*
The following is invalid formatting. It is intended to mark up a literal value, `openshift-*`, in bold highlighting.
Because of the two asterisks, AsciiDoctor does not know which asterisk is the closing tag.

Travis reports _Opening and ending tag mismatch:_.

----
*`openshift-*`*
----

*Solution*
Use an escape character for the second asterisk or use double asterisks:

++++
**`openshift-*`**
++++

==== Quick Reference
.User accounts and info
[option="header"]
Expand Down

0 comments on commit 3f466dd

Please sign in to comment.