Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
6ad9f44
docs: design spec for toggleable card theme
ebuildy Jun 28, 2026
ed7ebd4
docs: add project avatar to card theme spec
ebuildy Jun 28, 2026
fdb0c1b
docs: implementation plan for card theme + project avatar
ebuildy Jun 28, 2026
a49af54
feat: add card theme CSS builder and option validation
ebuildy Jun 28, 2026
2bba79a
feat: drive card styles from --gl-card-* theme variables
ebuildy Jun 28, 2026
ca14a22
feat: add docusaurus plugin that injects the card theme
ebuildy Jun 28, 2026
df5054c
build: expose @ebuildy/docusaurus-plugin-gitlab/plugin entry
ebuildy Jun 28, 2026
f1453ab
feat: localize project avatar at build time
ebuildy Jun 28, 2026
7783fed
feat: show project avatar in GitlabProjectInfo
ebuildy Jun 28, 2026
9b00c6d
fix: accept Docusaurus-injected id in theme plugin options
ebuildy Jun 28, 2026
49534d5
docs: wire and document the card theme plugin
ebuildy Jun 28, 2026
a3649ef
docs: wire the card theme plugin into the live gitlab example
ebuildy Jun 28, 2026
69d6b0c
refactor: drop theme plugin for stable CSS classes + README snippet
ebuildy Jun 28, 2026
f8ffd4b
docs: style the live gitlab example via custom.css
ebuildy Jun 28, 2026
f060a17
feat: humanize star and fork counts (6000 -> 6k)
ebuildy Jun 28, 2026
fd8b4c9
feat: ship theme.css with release styling; consume it in the example
ebuildy Jun 28, 2026
3b63556
feat: style the issues list with dedicated classes and state badge
ebuildy Jun 28, 2026
2040f84
style: render releases as a vertical timeline
ebuildy Jun 28, 2026
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
42 changes: 39 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,9 +190,45 @@ no tokens shipped, no client-side API calls, no CORS.

## Styling

Components use [Infima](https://infima.dev/) CSS variables, so they inherit your
site's theme (including dark mode) automatically. They're exported as normal
components, so you can wrap or restyle them as needed.
The components ship **without any bundled CSS** — they render plain, stable class
names so you stay in full control of the look. The package includes an optional,
light/dark-aware theme (`theme.css`) you can apply as-is or use as a starting
point. It's built on [Infima](https://infima.dev/) variables, so it tracks your
site's active theme automatically.

Apply it from your `classic` preset's `theme.customCss`:

```ts
// docusaurus.config.ts (ESM)
import { createRequire } from "node:module";
const require = createRequire(import.meta.url);

// ...inside the classic preset options:
theme: {
customCss: require.resolve("@ebuildy/docusaurus-plugin-gitlab/theme.css"),
},
```

Prefer to own the CSS? Copy
[`theme.css`](https://github.com/ebuildy/docusaurus-plugin-gitlab/blob/main/theme.css)
into your `src/css/custom.css` and edit freely. The class names you can target:

| Class | Element |
|---|---|
| `gitlab-card` | `<GitlabProjectInfo>` container |
| `gitlab-card-header` | avatar + title row |
| `gitlab-avatar` | project avatar image |
| `gitlab-title` | project / release title |
| `gitlab-muted` | secondary text (dates, authors, descriptions) |
| `gitlab-badge` | topics, tags, labels, release assets |
| `gitlab-stats` | stars / forks / updated row |
| `gitlab-issues` / `gitlab-issue` | issues list + each issue row |
| `gitlab-issue-state` / `gitlab-issue-title` | issue state badge (`data-state`) + title link |
| `gitlab-releases` / `gitlab-release` | releases list + each release card |
| `gitlab-release-notes` / `gitlab-release-assets` | release body + asset links |
| `gitlab-readme` | rendered README / markdown file |
| `gitlab-fallback` | error fallback box |
| `gitlab-code` / `gitlab-code-title` / `gitlab-code-pre` | code file embed |

## Development

Expand Down
Loading
Loading