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

Fix Slim template example #387

Merged
merged 1 commit into from Jun 3, 2024
Merged

Fix Slim template example #387

merged 1 commit into from Jun 3, 2024

Conversation

ghost
Copy link

@ghost ghost commented Jun 3, 2024

Changing | {{embed}} to == embed, because | {{embed}} not work.

Summary by CodeRabbit

  • Documentation
    • Updated instructions for embedding content in HTML files.

Changing `| {{embed}}` to `== embed`, because `| {{embed}}` not work.
@ghost ghost self-requested a review as a code owner June 3, 2024 05:33
@ghost ghost requested review from gaby, sixcolors, ReneWerner87 and efectn and removed request for a team June 3, 2024 05:33
@github-actions github-actions bot added the 📒 Documentation Improvements or additions to documentation label Jun 3, 2024
@ghost ghost changed the title Update README.md Fix Slim template example Jun 3, 2024
Copy link

coderabbitai bot commented Jun 3, 2024

Walkthrough

The recent update modifies the syntax for embedding content within an HTML file, specifically changing how the embed content is included in the body section. This adjustment aims to streamline and standardize the embedding process, ensuring consistency and potentially improving readability and maintainability.

Changes

Files Change Summary
slim/README.md Updated to reflect the new syntax for embedding content within the body section.

Poem

In the land of code, where syntax flows,
A change in embed now clearly shows.
HTML's body, with content anew,
Streamlined and simple, for all to view.
Cheers to the update, concise and bright,
Making our coding journey light! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between eccb6ac and a7e6c1d.

Files selected for processing (1)
  • slim/README.md (1 hunks)
Additional context used
LanguageTool
slim/README.md

[style] ~6-~6: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 627 characters long)
Context: ...ub/v/tag/gofiber/template?filter=slim*) Discord Test ![Security](https://github.com/gofiber/te...

Markdownlint
slim/README.md

47-47: Column: 1
Hard tabs


49-49: Column: 1
Hard tabs


50-50: Column: 1
Hard tabs


52-52: Column: 1
Hard tabs


56-56: Column: 1
Hard tabs


57-57: Column: 1
Hard tabs


59-59: Column: 1
Hard tabs


60-60: Column: 1
Hard tabs


61-61: Column: 1
Hard tabs


63-63: Column: 1
Hard tabs


64-64: Column: 1
Hard tabs


65-65: Column: 1
Hard tabs


66-66: Column: 1
Hard tabs


68-68: Column: 1
Hard tabs


69-69: Column: 1
Hard tabs


70-70: Column: 1
Hard tabs


71-71: Column: 1
Hard tabs


72-72: Column: 1
Hard tabs


73-73: Column: 1
Hard tabs


75-75: Column: 1
Hard tabs


76-76: Column: 1
Hard tabs


77-77: Column: 1
Hard tabs


78-78: Column: 1
Hard tabs


79-79: Column: 1
Hard tabs


80-80: Column: 1
Hard tabs


82-82: Column: 1
Hard tabs


17-17: null
Fenced code blocks should be surrounded by blank lines


23-23: null
Fenced code blocks should be surrounded by blank lines


25-25: null
Fenced code blocks should be surrounded by blank lines


27-27: null
Fenced code blocks should be surrounded by blank lines


29-29: null
Fenced code blocks should be surrounded by blank lines


31-31: null
Fenced code blocks should be surrounded by blank lines


33-33: null
Fenced code blocks should be surrounded by blank lines

Additional comments not posted (1)
slim/README.md (1)

40-40: Change in embedding syntax needs clarification.

The change from | {{embed}} to == embed is significant. Please ensure that this syntax is supported by the Slim template engine as intended. If possible, provide a reference to the documentation or commit that introduced this syntax change.

@ReneWerner87
Copy link
Member

thx, you are right we use it like this in our tests
https://github.com/gofiber/template/blob/master/slim/views/layouts/main.slim#L6C5-L6C13

@ReneWerner87 ReneWerner87 merged commit fc0eea4 into gofiber:master Jun 3, 2024
16 checks passed
@ghost ghost deleted the patch-1 branch June 3, 2024 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📒 Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant