-
Notifications
You must be signed in to change notification settings - Fork 382
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
Tags that appear in code blocks get evaluated, escaped tags render weird #267
Comments
Use @@
…Sent from my iPhone
On Feb 15, 2017, at 11:00 AM, Juan Orozco ***@***.***> wrote:
I was documenting a documentation process when I ran into this issue. I thought that a code block would change the behavior of DocumentJS. I also expected that escaping a tag would behave a certain way. Both situations have some issues. I'm listing both here because I'm not sure how best to solve the overall concern, which is how to escape a tag.
Code Block Issue
When a tag appears in a code block, like @Package, it should probably not be processed by documentjs engine.
If I have something like the following in a code block, for example, I would expect it to be skipped.
@Package <MY_PATH_TO_PACKAGE.JSON>
Rendering an escaped tag
Attempting to escape a tag doesn't work as one would think either. Using ***@***.*** works in that the tag gets skipped but then the resulting documentation looks weird as the slash does not get removed.
Escaping tag behaviors
I think this issue should really just define these behaviors first.
So, what should happen when...
A tag appears in a code block
A tag is escaped using \.
(Am I missing any others?)
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub, or mute the thread.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I was documenting a documentation process when I ran into this issue. I thought that a code block would change the behavior of DocumentJS. I also expected that escaping a tag would behave a certain way. Both situations have some issues. I'm listing both here because I'm not sure how best to solve the overall concern, which is how to escape a tag.
Code Block Issue
When a tag appears in a code block, like
@package
, it should probably not be processed by documentjs engine.If I have something like the following in a code block, for example, I would expect it to be skipped.
@package <MY_PATH_TO_PACKAGE.JSON>
Rendering an escaped tag
Attempting to escape a tag doesn't work as one would think either. Using
\@package
works in that the tag gets skipped but then the resulting documentation looks weird as the slash does not get removed.Escaping tag behaviors
I think this issue should really just define these behaviors first.
So, what should happen when...
\
.The text was updated successfully, but these errors were encountered: