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

feat: dark mode #19

Merged
merged 3 commits into from
Jul 9, 2024
Merged

feat: dark mode #19

merged 3 commits into from
Jul 9, 2024

Conversation

ThaddeusJiang
Copy link
Owner

@ThaddeusJiang ThaddeusJiang commented Jul 8, 2024

CleanShot 0006-07-08 at 21 29 27

Summary by CodeRabbit

  • New Features

    • Introduced automatic dark mode switching in TiddlyJam.
    • Added support for generating Chinese phonetic URL aliases.
  • Bug Fixes

    • Updated button symbols in the published dates display for consistency.
  • Enhancements

    • Improved the style of links, blockquotes, and media queries for better visual coherence.
    • Added references to external CSS and JavaScript libraries for styling and syntax highlighting.
  • Chores

    • Updated metadata and versioning for the TiddlyJam plugin.
    • Adjusted titles and modification timestamps for consistency and accuracy.

@ThaddeusJiang ThaddeusJiang self-assigned this Jul 8, 2024
Copy link

coderabbitai bot commented Jul 8, 2024

Walkthrough

The changes enhance the TiddlyJam plugin for TiddlyWiki by updating various metadata, improving URL and date handling, as well as updating CSS for better styling, including support for dark mode and Chinese phonetic URL aliases. Version updates and consistency improvements in titles are also made. New functionality includes automatic dark mode switching and code highlighting via highlight.js.

Changes

File/Directory Change Summary
.gitignore Added patterns $__StoryList*, $__StoryList.tid, and $__Import*.tid to ignore list.
plugins/tiddlyjam/$__AbsoluteBaseUrl.tid Updated modification timestamp and URL content.
plugins/tiddlyjam/$__plugins_adithyab_tiddlyjam.json.meta Introduced metadata for the TiddlyJam plugin, version 0.2.10.
plugins/tiddlyjam/$__plugins_adithyab_tiddlyjam_backendui_category_row_published.tid Updated timestamp and changed button symbol from 'X' to '×'.
plugins/tiddlyjam/$__plugins_adithyab_tiddlyjam_renderer_base_imports.tid Added references to external CSS and JavaScript libraries.
.../TiddlyJam Settings.tid Updated title from "Welcome to ~TiddlyJam" to "Welcome to TiddlyJam."
.../plugin.info Updated version from 0.2.8 to 0.2.10.
.../vanilla.css Introduced styling changes for a elements, blockquotes, and media queries for light and dark schemes.
.../vanilla.css.meta Created with metadata related to CSS styling for TiddlyJam.
tiddlers/$__DefaultTiddlers.tid Modified title reference from [[~TiddlyJam]] to [[TiddlyJam]].
tiddlers/Getting Started with TiddlyJam.tid Updated the modified timestamp.
tiddlers/TiddlyJam automatically Dark mode.tid Introduced automatic dark mode switching functionality.
tiddlers/TiddlyJam support 中文拼音 URL.tid Introduced support for Chinese phonetic URL aliases.
tiddlers/TiddlyJam.tid Modified title, adjusted modified timestamp, and added a new features section.
tiddlers/code highlight via highlight.js.tid Updated tags and title metadata for code highlighting.
tiddlers/dark-mode-demo.mp4.meta Introduced metadata for dark-mode-demo video.
tiddlers/index.tid Modified name field and updated modified timestamp.

Poem

In the wiki world where stories bloom,
TiddlyJam got some love and room.
Dark mode and phonetic URL delight 🌙,
Styled links and highlights so bright.
URLs, timestamps, and meta fine-tuned,
TiddlyJam rises, perfectly attuned. 🌟


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 54cf361 and fa54fd4.

Files selected for processing (1)
  • tiddlers/tiddlyjam.min.css.meta (1 hunks)
Files skipped from review due to trivial changes (1)
  • tiddlers/tiddlyjam.min.css.meta

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 fa54fd4 and e275b6a.

Files ignored due to path filters (1)
  • tiddlers/dark-mode-demo.mp4 is excluded by !**/*.mp4
Files selected for processing (16)
  • .gitignore (1 hunks)
  • plugins/tiddlyjam/$__AbsoluteBaseUrl.tid (1 hunks)
  • plugins/tiddlyjam/$__plugins_adithyab_tiddlyjam.json.meta (1 hunks)
  • plugins/tiddlyjam/$__plugins_adithyab_tiddlyjam_backendui_category_row_published.tid (1 hunks)
  • plugins/tiddlyjam/$__plugins_adithyab_tiddlyjam_renderer_base_imports.tid (1 hunks)
  • plugins/tiddlyjam/TiddlyJam Settings.tid (1 hunks)
  • plugins/tiddlyjam/plugin.info (1 hunks)
  • plugins/tiddlyjam/tiddlyjam.min.css.meta (1 hunks)
  • tiddlers/$__DefaultTiddlers.tid (1 hunks)
  • tiddlers/Getting Started with TiddlyJam.tid (1 hunks)
  • tiddlers/TiddlyJam automatically Dark mode.tid (1 hunks)
  • tiddlers/TiddlyJam support 中文拼音 URL.tid (1 hunks)
  • tiddlers/TiddlyJam.tid (2 hunks)
  • tiddlers/code highlight via highlight.js.tid (1 hunks)
  • tiddlers/dark-mode-demo.mp4.meta (1 hunks)
  • tiddlers/index.tid (1 hunks)
Files skipped from review due to trivial changes (15)
  • .gitignore
  • plugins/tiddlyjam/$__AbsoluteBaseUrl.tid
  • plugins/tiddlyjam/$__plugins_adithyab_tiddlyjam.json.meta
  • plugins/tiddlyjam/$__plugins_adithyab_tiddlyjam_backendui_category_row_published.tid
  • plugins/tiddlyjam/$__plugins_adithyab_tiddlyjam_renderer_base_imports.tid
  • plugins/tiddlyjam/TiddlyJam Settings.tid
  • plugins/tiddlyjam/plugin.info
  • plugins/tiddlyjam/tiddlyjam.min.css.meta
  • tiddlers/$__DefaultTiddlers.tid
  • tiddlers/Getting Started with TiddlyJam.tid
  • tiddlers/TiddlyJam automatically Dark mode.tid
  • tiddlers/TiddlyJam support 中文拼音 URL.tid
  • tiddlers/code highlight via highlight.js.tid
  • tiddlers/dark-mode-demo.mp4.meta
  • tiddlers/index.tid
Additional comments not posted (2)
tiddlers/TiddlyJam.tid (2)

2-2: Timestamp update is appropriate.

The modified timestamp correctly reflects the recent changes made to the file.


4-4: Title update is appropriate.

The title field has been correctly updated to remove the tilde (~), standardizing the title format.

Copy link

vercel bot commented Jul 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
tiddlyjam ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 9, 2024 2:10am

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 e275b6a and 8e86dbf.

Files selected for processing (5)
  • plugins/tiddlyjam/$__plugins_adithyab_tiddlyjam.json.meta (1 hunks)
  • plugins/tiddlyjam/plugin.info (1 hunks)
  • plugins/tiddlyjam/vanilla.css (1 hunks)
  • plugins/tiddlyjam/vanilla.css.meta (1 hunks)
  • tiddlers/Getting Started with TiddlyJam.tid (2 hunks)
Files skipped from review due to trivial changes (1)
  • plugins/tiddlyjam/vanilla.css.meta
Files skipped from review as they are similar to previous changes (2)
  • plugins/tiddlyjam/$__plugins_adithyab_tiddlyjam.json.meta
  • tiddlers/Getting Started with TiddlyJam.tid
Additional comments not posted (6)
plugins/tiddlyjam/plugin.info (1)

9-9: Verify the version bump.

The version was updated to 0.2.10. Ensure that this change is consistent with your semantic versioning practices and that all related files are updated accordingly.

plugins/tiddlyjam/vanilla.css (5)

1-3: Ensure the usage of word-break: break-all; for a elements is intentional.

While this style prevents overflow issues, it might affect readability by breaking words or URLs.


5-13: Verify consistency of blockquote styles with overall design.

The new styles for blockquote elements enhance visual appearance. Ensure these styles align with the overall design theme.


15-22: Verify consistency of blockquote.tc-big-quote styles with design guidelines.

The new styles for blockquote.tc-big-quote elements provide a distinct appearance. Ensure these styles align with the design guidelines.


24-26: Verify consistency of blockquote.tc-big-quote cite:before styles with citation formatting guidelines.

The new style adds a visual separator before the citation. Ensure this style aligns with the citation formatting guidelines.


28-46: Verify appropriateness of font families for light and dark color schemes.

The media queries define font-family variables for light and dark color schemes. Ensure that these font families are suitable for both modes.

@ThaddeusJiang ThaddeusJiang merged commit f62f1c2 into main Jul 9, 2024
2 checks passed
@ThaddeusJiang ThaddeusJiang deleted the feat/dark-mode branch July 9, 2024 02:17
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.

1 participant