Github preset

Pro

GitHub's repository objects, as entity kinds. Pass to EntityKindsProvider: <EntityKindsProvider kinds={githubKinds}>. The nouns are GitHub's own: a repository holds a project's files and history, an issue is a suggested improvement, task or question, a pull request is a proposed change, a commit is one change to a set of files, a branch is a parallel version of a repository, a workflow run is one execution of a GitHub Actions workflow, and a release packages software for its users.

Markdown

Version 5.2.0· other versions

This page is for 5.2.0, the current release. An earlier release’s page is the Markdown that release published, so the docs match the version you have installed (candor-lock.json records it).

Not in the docs of 1.3.0, 1.4.0, 1.5.0, 1.5.1, 1.6.0, 1.7.0, 1.8.0, 1.8.1, 1.9.0, 1.9.1, 2.0.0, 2.1.0, 2.2.0, 2.3.0, 2.4.0, 2.5.0, 2.5.1, 2.6.0, 2.6.1, 2.6.2, 2.7.0, 2.8.0, 2.9.0, 2.10.0 and 3.0.0: the page came later, or had another name then.

Docs pages weren’t kept for 1.0.0, 1.0.1, 1.1.0, 1.1.1, 1.2.0 and 1.2.1: they are kept from 1.3.0 on, and before that only llms.txt was published.

Preview

Install

With the Candor CLI

First time? Get started sets up the registry and theme. Or with shadcn directly: npx shadcn@latest add @candor/github-preset

Brings in: entity-chip, fill-strings, tokens · npm: lucide-react@^1.67.0

Usage

TSX · The example above

"use client"

import { EntityChip, EntityKindsProvider } from "@/components/candor/entity-chip"
import { githubKinds } from "@/components/candor/github-preset"

export default function Example() {
  return (
    <EntityKindsProvider kinds={githubKinds}>
      <p className="flex max-w-lg flex-wrap items-center gap-2 text-sm">
        <EntityChip entity={{ kind: "repository", name: "candor-ui" }} onOpen={() => {}} />
        <EntityChip entity={{ kind: "issue", name: "#212 Chip truncates" }} onOpen={() => {}} />
        <EntityChip entity={{ kind: "pullRequest", name: "#219 Fix truncation" }} onOpen={() => {}} />
        <EntityChip entity={{ kind: "commit", name: "3ae25b6" }} onOpen={() => {}} />
        <EntityChip entity={{ kind: "branch", name: "release/2.0" }} onOpen={() => {}} />
        <EntityChip entity={{ kind: "workflowRun", name: "CI #1432" }} onOpen={() => {}} />
        <EntityChip entity={{ kind: "release", name: "v2.0.0" }} onOpen={() => {}} />
      </p>
    </EntityKindsProvider>
  )
}

Values

githubKinds

Record<string, EntityKindInfo>

githubNouns

GitHub's nouns for LocaleProvider's nouns: agents act in a repository, which an organization owns.

Partial<NounTable>