Skip to content

update docs #75

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.

Sign up for GitHub

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

Merged
rprtr258 merged 1 commit into from
Jan 31, 2026
Merged

update docs #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/bun.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

44 changes: 44 additions & 0 deletions docs/github-corner.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
export const icon = ["svg", {
width: "80",
height: "80",
viewBox: "0 0 250 250",
style: [
// TODO: depend on style
"fill: #333333;",
"color: #ccc8b1;",
"position: absolute;",
"top: 0;",
"border: 0;",
"right: 0;",
].join(" "),
Comment on lines +5 to +13
Copy link

@coderabbitai coderabbitai bot Jan 31, 2026

Choose a reason for hiding this comment

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

🧹 Nitpick | 🔵 Trivial

Address TODO: Hardcoded colors should reference theme variables.

The inline style contains hardcoded colors (#333333, #ccc8b1) that should ideally be derived from the theme for consistency. The existing TODO comment on line 6 acknowledges this.

Would you like me to help integrate theme variables here, or open an issue to track this?

🤖 Prompt for AI Agents 
In `@docs/github-corner.ts` around lines 5 - 13, The inline style array in
docs/github-corner.ts currently uses hardcoded colors ("#333333", "#ccc8b1");
replace those literals with theme-derived values by referencing the theme or CSS
variables used across the app (e.g., use theme.colors.* or CSS vars like
var(--color-xxx)) instead of literals. Locate the style array (the style: [ ...
].join(" ") block) and change the color entries to use the appropriate theme
tokens (for example theme.colors.background / theme.colors.text or corresponding
CSS custom properties) so the component respects the app theme; ensure you
import or accept the theme/CSS variables used elsewhere and update any tests or
usages if the API changes.

"aria-hidden": "true",
},
["path", {d: "M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"}],
["path", {fill: "currentColor", style: "transform-origin: 130px 106px;", class: "octo-arm", d: "M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2"}],
["path", {fill: "currentColor", class: "octo-body", d: "M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z"}],
] as const;

export const style = ["style", {}, `
.github-corner:hover .octo-arm {
animation:octocat-wave 560ms ease-in-out;
}
@keyframes octocat-wave {
0%,100% {
transform:rotate(0);
}
20%,60% {
transform:rotate(-25deg);
}
40%,80% {
transform:rotate(10deg);
}
}
@media (max-width:500px){
.github-corner:hover .octo-arm{
animation:none;
}
.github-corner .octo-arm{
animation:octocat-wave 560ms ease-in-out;
}
}
`] as const;
101 changes: 96 additions & 5 deletions docs/index.html
View file
Open in desktop

Large diffs are not rendered by default.

Loading
Loading