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

Change the title format to include the subtitle. #427

Closed
wants to merge 2 commits into from

Conversation

FrederickBun
Copy link
Contributor

@FrederickBun FrederickBun commented Sep 1, 2024

Main page: {sitetitle} - {subtitle}
Other page: {pagetitle} | {sitetitle}

It was supposed to be written in the theme configuration that the user can choose which one to use, but I haven't done it yet.

Summary by CodeRabbit

  • New Features
    • Introduced a new site subtitle: "Redefine Your Hexo Journey," enhancing site description.
    • Improved page title formatting to include the subtitle, providing a clearer and more informative title display in the browser.

Copy link

coderabbitai bot commented Sep 1, 2024

Walkthrough

Walkthrough

The changes include the addition of a site subtitle in the _config.yml file, enhancing the site's descriptive capabilities. Additionally, the layout/_partials/head.ejs file was modified to adjust the HTML title element, incorporating a pipe separator and conditionally appending the subtitle when available. These updates improve the overall presentation of the site title in the browser.

Changes

File Change Summary
_config.yml Added a new subtitle entry under the info section: "Redefine Your Hexo Journey."
layout/_partials/head.ejs Adjusted title formatting to use a pipe (`

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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@FrederickBun
Copy link
Contributor Author

@coderabbitai review

Copy link

coderabbitai bot commented Sep 1, 2024

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0a1c561 and be36122.

Files selected for processing (2)
  • _config.yml (1 hunks)
  • layout/_partials/head.ejs (1 hunks)
Files skipped from review due to trivial changes (1)
  • _config.yml
Additional comments not posted (2)
layout/_partials/head.ejs (2)

74-75: LGTM!

The code changes are approved. The pipe separator is being appended to the title when it is present, which is a valid change.


76-77: LGTM!

The code changes are approved. The subtitle is being appended to the title with a hyphen separator when it is available in the theme configuration. This change aligns with the PR objective of including the subtitle in the title format.

@EvanNotFound
Copy link
Owner

EvanNotFound commented Sep 2, 2024

Thanks for the PR.

I've noticed an issue with the title logic:

When both theme.info.subtitle and theme.info.title (or their fallback values) are present, the title and theme title get rendered twice, leading to something like:

<title>My Page Title | My Theme Title - Subtitle My Theme Title</title>

Due to these issues, I won’t be merging this PR. Please address these concerns and feel free to resubmit when ready.

@FrederickBun FrederickBun mentioned this pull request Sep 4, 2024
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.

2 participants