obsidian-ui-skills

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Obsidian UI Skills

Obsidian UI 设计规范

Opinionated constraints for building Obsidian-style interfaces with AI agents.
这是为AI Agent构建Obsidian风格界面的约束性指南。

When to Apply

适用场景

Reference these guidelines when:
  • Building dark-mode interfaces
  • Creating Obsidian-inspired design systems
  • Implementing UIs with Inter font and 4px grid
在以下场景中参考这些指南:
  • 构建深色模式界面
  • 创建Obsidian风格的设计系统
  • 实现采用Inter字体和4px网格的UI

Colors

颜色规范

  • MUST use dark backgrounds (lightness < 20) for primary surfaces - detected lightness: 0
  • MUST use
    #000000
    as page background (
    surface-base
    )
  • MUST use
    #6930C7
    for primary actions and focus states (
    accent
    )
  • SHOULD reduce color palette (currently 24 colors detected)
  • MUST maintain text contrast ratio of at least 4.5:1 for accessibility
  • 主界面必须使用深色背景(亮度 < 20)——当前检测到的亮度为0
  • 页面背景必须使用
    #000000
    surface-base
  • 主要操作和焦点状态必须使用
    #6930C7
    accent
  • 应精简调色板(当前检测到24种颜色)
  • 为保证可访问性,文本对比度必须至少达到4.5:1

Semantic Tokens

语义化令牌

TokenHEXRGBUsage
surface-base
#000000rgb(0,0,0)Page background
surface-raised
#FEFEFDrgb(254,254,253)Cards, modals, raised surfaces
surface-overlay
#151027rgb(21,16,39)Overlays, tooltips, dropdowns
text-primary
#858585rgb(133,133,133)Headings, body text
text-secondary
#3A2F66rgb(58,47,102)Secondary, muted text
text-tertiary
#555555rgb(85,85,85)Additional text
border-default
#2F2F2Frgb(47,47,47)Subtle borders, dividers
warning
#FEFEFDrgb(254,254,253)Warning states, cautions
accent
#6930C7rgb(105,48,199)Primary actions, links, focus
令牌十六进制值RGB值用途
surface-base
#000000rgb(0,0,0)页面背景
surface-raised
#FEFEFDrgb(254,254,253)卡片、模态框、凸起界面
surface-overlay
#151027rgb(21,16,39)覆盖层、工具提示、下拉菜单
text-primary
#858585rgb(133,133,133)标题、正文文本
text-secondary
#3A2F66rgb(58,47,102)次要、弱化文本
text-tertiary
#555555rgb(85,85,85)附加文本
border-default
#2F2F2Frgb(47,47,47)细微边框、分隔线
warning
#FEFEFDrgb(254,254,253)警告状态、提示
accent
#6930C7rgb(105,48,199)主要操作、链接、焦点

Typography

排版规范

  • MUST use
    Inter
    as primary font family
  • SHOULD use single font family for consistency
  • MUST use
    78px
    /
    700
    for primary headings
  • MUST use
    14px
    /
    400
    for body text
  • SHOULD reduce font weights (currently 5 detected)
  • MUST use
    text-balance
    for headings and
    text-pretty
    for body text
  • SHOULD use
    tabular-nums
    for numeric data
  • NEVER modify letter-spacing unless explicitly requested
  • 必须使用
    Inter
    作为主要字体族
  • 为保证一致性,应使用单一字体族
  • 主标题必须使用
    78px
    /
    700
    (字号/字重)
  • 正文文本必须使用
    14px
    /
    400
  • 应精简字重(当前检测到5种字重)
  • 标题必须使用
    text-balance
    ,正文必须使用
    text-pretty
  • 数值数据应使用
    tabular-nums
  • 除非明确要求,否则绝不能修改字母间距

Text Styles

文本样式

StyleFontSizeWeightColorCount
heading-1
Inter78px700#CDCDCD1
text-41px
Inter41px500#8D8D8D1
text-24px
Inter24pxsemi_bold#3939391
text-20px
Inter20px400#695C941
text-19px
Inter19px500#9393931
text-19px
Inter19px400#DDB5F81
text-16px
Inter16px500#6666661
text-16px
Inter16pxsemi_bold#B8B8B81
body
Inter14px400#7070701
body-secondary
Inter14px400#7474741
样式字体字号字重颜色数量
heading-1
Inter78px700#CDCDCD1
text-41px
Inter41px500#8D8D8D1
text-24px
Inter24pxsemi_bold#3939391
text-20px
Inter20px400#695C941
text-19px
Inter19px500#9393931
text-19px
Inter19px400#DDB5F81
text-16px
Inter16px500#6666661
text-16px
Inter16pxsemi_bold#B8B8B81
body
Inter14px400#7070701
body-secondary
Inter14px400#7474741

Typography Reference

排版参考

Font Families:
  • Inter
    (used 71x)
Font Sizes: 7px, 8px, 9px, 10px, 11px, 12px, 13px, 14px, 16px, 19px, 20px, 24px, 41px, 78px
字体族:
  • Inter
    (使用次数71次)
**字号:**7px, 8px, 9px, 10px, 11px, 12px, 13px, 14px, 16px, 19px, 20px, 24px, 41px, 78px

Spacing

间距规范

  • MUST use 4px grid for spacing
  • SHOULD use spacing from scale: 1px, 2px, 3px, 4px, 5px, 6px, 7px, 8px
  • SHOULD use 2px as default gap between elements
  • NEVER use arbitrary spacing values (use design scale)
  • SHOULD maintain consistent padding within containers
  • 必须使用4px网格进行间距设置
  • 应使用以下间距刻度:1px, 2px, 3px, 4px, 5px, 6px, 7px, 8px
  • 元素间默认间距应使用2px
  • 绝不能使用任意间距值(必须使用设计刻度)
  • 容器内的内边距应保持一致

Borders

边框规范

  • MUST use border-radius from scale: 3px, 4px, 5px, 6px, 8px, 11px, 23px
  • SHOULD use 23px+ radius for pill-shaped elements
  • SHOULD limit border widths to: 1px, 2px
  • SHOULD use 4px as default border-radius
  • NEVER use arbitrary border-radius values (use design scale)
  • SHOULD use subtle borders (1px) for element separation
  • 必须使用以下圆角刻度:3px, 4px, 5px, 6px, 8px, 11px, 23px
  • 胶囊形元素应使用23px及以上的圆角
  • 边框宽度应限制为1px、2px
  • 默认圆角应使用4px
  • 绝不能使用任意圆角值(必须使用设计刻度)
  • 元素分隔应使用细微边框(1px)

Border Radius Reference

圆角参考

Scale: 3px, 4px, 5px, 6px, 8px, 11px, 23px
**刻度:**3px, 4px, 5px, 6px, 8px, 11px, 23px

Layout

布局规范

  • MUST design for 1920px base viewport width
  • SHOULD use consistent element widths: 8px, 11px, 10px, 12px, 9px
  • SHOULD maintain text-heavy layout with clear hierarchy
  • NEVER use
    h-screen
    , use
    h-dvh
    for full viewport height
  • MUST respect
    safe-area-inset
    for fixed elements
  • SHOULD use
    size-*
    for square elements instead of
    w-*
    +
    h-*
  • 必须以1920px作为基础视口宽度进行设计
  • 应使用一致的元素宽度:8px, 11px, 10px, 12px, 9px
  • 应保持以文本为主的布局,层级清晰
  • 绝不能使用
    h-screen
    ,应使用
    h-dvh
    实现全屏高度
  • 固定元素必须考虑
    safe-area-inset
  • 方形元素应使用
    size-*
    而非
    w-*
    +
    h-*

Detected Layout Patterns

检测到的布局模式

  • Main Content: width: 1920px, height: 1080px
  • Main Content: width: 1920px, height: 643px
  • 主内容区:宽度1920px,高度1080px
  • 主内容区:宽度1920px,高度643px

Components

组件规范

  • MUST use
    0px
    height for input fields
  • 输入框高度必须使用
    0px

Buttons

按钮

VariantBackgroundTextBorderHeightRadius
Ghosttransparent#3A2F66none--
变体背景文本边框高度圆角
Ghosttransparent#3A2F66none--

Inputs

输入框

  • Height:
    0px
  • 高度:
    0px

Interactive States

交互状态

Focus

焦点状态

  • MUST use
    2px
    outline with accent color (
    #6930C7
    )
  • MUST use
    2px
    outline-offset
  • NEVER remove focus indicators
  • 必须使用2px宽的强调色(
    #6930C7
    )外轮廓
  • 必须使用2px的外轮廓偏移量
  • 绝不能移除焦点指示器

Hover

悬停状态

  • Buttons (primary): lighten background by 10%
  • Buttons (secondary): use
    #FEFEFD
    background
  • List items: use
    #FEFEFD
    background
  • 主按钮:背景亮度提高10%
  • 次按钮:使用
    #FEFEFD
    作为背景
  • 列表项:使用
    #FEFEFD
    作为背景

Disabled

禁用状态

  • MUST use
    opacity: 0.5
  • MUST use
    cursor: not-allowed
  • 必须使用
    opacity: 0.5
  • 必须使用
    cursor: not-allowed

Interaction

交互规范

  • MUST use an
    AlertDialog
    for destructive or irreversible actions
  • SHOULD use structural skeletons for loading states
  • MUST show errors next to where the action happens
  • NEVER block paste in
    input
    or
    textarea
    elements
  • MUST add an
    aria-label
    to icon-only buttons
  • 破坏性或不可逆操作必须使用
    AlertDialog
  • 加载状态应使用结构化骨架屏
  • 错误提示必须显示在操作发生的位置附近
  • 绝不能禁止在
    input
    textarea
    元素中粘贴内容
  • 纯图标按钮必须添加
    aria-label

Animation

动画规范

  • NEVER add animation unless it is explicitly requested
  • MUST animate only compositor props (
    transform
    ,
    opacity
    )
  • NEVER animate layout properties (
    width
    ,
    height
    ,
    top
    ,
    left
    ,
    margin
    ,
    padding
    )
  • SHOULD use
    ease-out
    on entrance animations
  • NEVER exceed
    200ms
    for interaction feedback
  • SHOULD respect
    prefers-reduced-motion
  • 除非明确要求,否则绝不能添加动画
  • 必须仅对 compositor 属性(
    transform
    opacity
    )执行动画
  • 绝不能对布局属性(
    width
    height
    top
    left
    margin
    padding
    )执行动画
  • 入场动画应使用
    ease-out
  • 交互反馈动画时长绝不能超过200ms
  • 应尊重
    prefers-reduced-motion
    设置

Performance

性能规范

  • NEVER animate large
    blur()
    or
    backdrop-filter
    surfaces
  • NEVER apply
    will-change
    outside an active animation
  • NEVER use
    useEffect
    for anything that can be expressed as render logic
  • 绝不能对大面积
    blur()
    backdrop-filter
    区域执行动画
  • 绝不能在非活跃动画中使用
    will-change
  • 任何可通过渲染逻辑实现的内容,绝不能使用
    useEffect