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.

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

Unable to include handlebar example while using block helper within same doc block #433

Open
kidonchu opened this issue Mar 16, 2017 · 2 comments

Comments

@kidonchu
Copy link

kidonchu commented Mar 16, 2017

I have a doc block that looks like this. This correctly displays the link to Component.MyNewComponent. However, it displays empty content inside of the code block.

/**
 * Modal component
 *
 * This component almost always will be used with
 * {{#crossLink "Component.MyNewComponent"}}{{/crossLink}}.
 *
 * Usage:
 * ```handlebars
 * {{#my-component}}
 * Hello World
 * {{/my-component}}
 * ```
 */

If I apply the advice from #68 with escaping the first curly braces, \{{#my-component}}, then it displays the content of code block correctly. However, it breaks the crossLink helper and doesn't display the link to Component.MyNewComponent. Instead, it displays plain text including {{#crossLink...}}.

Is this happening because I'm doing something wrong? Or are we not supposed to use code block helper and handlebar example within the same doc block?

@markcellus
Copy link

I am also having this issue. Any word of advice?

@cristinawithout
Copy link

cristinawithout commented Aug 20, 2021

If anybody is still using YUIDoc & has the same issue, I just ran across this using .

It worked to escape both the opening & the closing for the component in the code block. The crossLinks work & the content of the code block shows.

/**
 * Modal component
 *
 * This component almost always will be used with
 * {{#crossLink "Component.MyNewComponent"}}{{/crossLink}}.
 *
 * Usage:
 * ```handlebars
 * \{{#my-component}}
 * Hello World
 * \{{/my-component}}
 * ```
 */

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants