Skip to content

Conversation

@yucheng11122017
Copy link
Contributor

…t.md boilerplate

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • DevOps
  • Improve developer experience
  • Others, please explain:

Overview of changes:

Currently in UG:
image

Changed to :
image

This is to be consistent with other code output formatting in the documentation

Anything you'd like to highlight/discuss:
Is there a need to create a new boilerplate just for nunjucks? Current boiler plates will not work with nunjucks due to the need for {%raw%} and {%endraw%} tags to escape the nunjucks.
Currently only one usage of nunjucks code and output which will be corrected in this PR

Testing instructions:

Proposed commit message: (wrap lines at 72 characters)
Change format of nunjucks code and output in UG


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

@yucheng11122017 yucheng11122017 requested a review from a team February 19, 2023 06:40
Copy link
Contributor

@lhw-1 lhw-1 left a comment

Choose a reason for hiding this comment

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

Good find & thanks for working on it @yucheng11122017! Seems to work on my end 👍

Current boiler plates will not work with nunjucks due to the need for {%raw%} and {%endraw%} tags to escape the nunjucks.

Just to check, you are referring to #2119, right? For now, since this is a viable workaround, maybe we can document this somewhere (or at least mention it in #2119) in case developers run into this exact problem in the future.

%%OUTPUT:%%
<div class="indented">

<box border-left-color={{ markbind_blue }} background-color="white">
Copy link
Contributor

Choose a reason for hiding this comment

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

May I know if this part of the codeAndOutput.md boilerplate appears blue on your end? The default boilerplate seems to appear grey on my end:

Capture

Or is there a reason why we are changing it to blue specifically?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Apologies, fixed in 479dd7d. I was working on a PR which changes it to blue

@yucheng11122017
Copy link
Contributor Author

Good find & thanks for working on it @yucheng11122017! Seems to work on my end 👍

Current boiler plates will not work with nunjucks due to the need for {%raw%} and {%endraw%} tags to escape the nunjucks.

Just to check, you are referring to #2119, right? For now, since this is a viable workaround, maybe we can document this somewhere (or at least mention it in #2119) in case developers run into this exact problem in the future.

Oh yes there are overlaps with #2119. I'm not sure if this would be considered a workaround though since its still not a boilerplate.

Copy link
Contributor

@jovyntls jovyntls left a comment

Choose a reason for hiding this comment

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

LGTM, nice that we're improving the consistency of our UG!

Is there a need to create a new boilerplate just for nunjucks? Current boiler plates will not work with nunjucks due to the need for {%raw%} and {%endraw%} tags to escape the nunjucks.
Currently only one usage of nunjucks code and output which will be corrected in this PR

IMO If this is the only usage of nunjucks code I think it's fine without a boilerplate :) (Though if we do manage to make the boilerplate work with nunjucks too, that's be great)

@jovyntls jovyntls added this to the v4.1.1 milestone Feb 21, 2023
@jovyntls jovyntls merged commit b385ab8 into MarkBind:master Feb 27, 2023
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

Successfully merging this pull request may close these issues.

3 participants