longbridge__developers/README.md at fix-assets

mirror of https://github.com/longbridge/developers.git synced 2026-09-19 03:34:09 +08:00

Files

T

Jason Lee e7e9a2d1ba feat: Update platform name to Longbridge Developers and UI improvements (#369 )

## Summary

- Rename project from "OpenAPI" to "Longbridge Developers" across all
locales, config, and docs
- Add local SVG assets for homepage features (replacing external CDN
URLs)
- **TipContainer**: replace emoji with SVG icons, Shadcn-style
border/bg/text per type using `data-type` + CSS `@apply`
- **Tabs**: improved tab styling, fix `ul`/`ol` indentation in tab
content
- **Sidebar**: active item uses brand color background (color-mix) with
rounded corners
- **Doc footer**: LLMs Text + Edit this page on same row, subdued
colors, lighter "Updated at"
- **Breadcrumb**: remove primary color
- **UserMenu**: rename Profile → Dashboard (控制台)
- **Style**: inline code color fix, blockquote updates, font
improvements

## Test plan

- [ ] Verify rename appears correctly in EN / zh-CN / zh-HK locales
- [ ] Check homepage SVGs load from `/assets/`
- [ ] Check TipContainer all 6 types render with correct
border/bg/text/icon colors in light and dark mode
- [ ] Check Tabs styling and list indentation
- [ ] Check sidebar active item background
- [ ] Check doc footer layout (LLMs Text + Edit this page same row)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

2026-03-18 14:35:26 +08:00

1.9 KiB

Raw Permalink Blame History

Longbridge Developers

https://open.longbridge.com

CONTRIBUTING

请阅读 CONTRIBUTING.md 文档。

Please following the CONTRIBUTING.md document.

Style Guide

文档需要遵守以下规范：

遵循中英文书写规范，中英文加空格间隔，正确使用标点符号，正确用词，精确专业术语用词、大小写。
Longbridge 员工请阅读内部：文案书写指导与 OpenAPI 接口规范。
Markdown 文档需要提供规范的 Meta 信息。

Markdown Meta 信息格式

在每个 .md 文件的开头添加内容（示例）：

---
title: '开放平台文档标题'
id: $category_$file_name # category 指文檔分類 file_name 指文档的文件名以中横线分隔的字符串
slug: '/xxx' # 注意前面必须加上 /，例如 /trade-order-create 这样的 slug 保持和 id 一致
sidebar_position: 1 // 显示的顺序，数字越小越靠前
---

Markdown 文档分类

为了将文档进行分类需要在 docs 中每个子目录添加 category.json 配置文件，文件内容如下：

{
  position: 1, // 显示的顺序，数字越小越靠前
  label: 'OpenAPI 介绍', // 文档分类名称，显示在左边栏
  link: null,
}

特别提示

Markdown 涉及到的静态资源例如：图片、视频等都需要上传到 CDN 再引用，不要放到项目中引用。

不推荐的写法（这样定义会导致加载资源失败的情况）

![流程图片](../../static/xxxx.png)

推荐的写法（从后台上传到 CDN 拿到 CDN 地址，然后在 Markdown 中引用）

![流程图片](https://pub.pbkrs.com/xxx/xxx.png)

Before commit you should be run autocorrect --fix . first How to use autocorrect

1.9 KiB Raw Permalink Blame History