根类名与状态

HTML 根类名JSON status含义
friendly"friendly"接受友链
unfriendly"unfriendly"友链已满/暂不接受(仅格式化标签含义)

版本号:HTML 根元素 id="v1.0";JSON "version": "1.0";JSON 顶层 "protocol": "friends"。

HTML 格式

<!DOCTYPE html><html lang="en">
<head><meta charset="UTF-8"><title>Friends</title>
<link rel="friends" type="application/json" href="/.well-known/friends.json"></head>
<body>
<div class="friendly" id="v1.0">
<a class="name link" href="https://example.com" lang="en">Example Site</a>
<!-- desc:short / long / 不区分(省略 data-length) -->
<span class="desc" data-length="short" lang="en">Frontend &amp; indie blogging.</span>
<span class="desc" data-length="long" lang="en">A site about frontend and independent blogging.</span>
<a class="logo" href="https://example.com/logo.png"
data-light="https://example.com/logo-light.png"
data-dark="https://example.com/logo-dark.png">Logo</a>
<a class="feed" href="https://example.com/feed.xml" type="application/rss+xml">RSS</a>
<a class="feed" href="https://example.com/atom.xml" type="application/atom+xml">Atom</a>
<a class="sitemap" href="https://example.com/sitemap.xml">Sitemap</a>
<a class="shot" href="https://example.com/screenshot.jpg">Screenshot</a>
<a class="news" href="https://example.com/newsletter">Newsletter</a>
<a class="contact" href="https://example.com/contact">Contact</a>
<data class="cat">tech</data>
<data class="cat">indieweb</data>
<data class="sub" lang="en">frontend</data>
<data class="themecolor" data-light="#f5f5f5" data-dark="#1a1a1a"></data>
<data class="loc">footer</data>
<data class="loc">sidebar</data>
<data class="frdrank">5</data>
</div>
<!-- <div class="unfriendly" id="v1.0">
<p>Friends list is full. Not accepting new applications.</p>
</div> -->
</body>
</html>

/.well-known/friends.json

{
  "protocol": "friends",
  "version": "1.0",
  "status": "friendly",
  "updated": "2026-11-18",
  "links": [
    {
      "name": { "value": "Example Site", "lang": "en" },
      "link": "https://example.com",
      "desc": {
        "short": { "value": "Frontend & indie blogging.", "lang": "en" },
        "long": { "value": "A site about frontend and independent blogging.", "lang": "en" }
      },
      "cat": ["tech", "indieweb"],
      "sub": [
        { "value": "frontend", "lang": "en" }
      ],
      "logo": {
        "light": "https://example.com/logo-light.png",
        "dark": "https://example.com/logo-dark.png"
      },
      "feed": [
        { "url": "https://example.com/feed.xml", "type": "application/rss+xml" },
        { "url": "https://example.com/atom.xml", "type": "application/atom+xml" }
      ],
      "sitemap": "https://example.com/sitemap.xml",
      "shot": "https://example.com/screenshot.jpg",
      "news": "https://example.com/newsletter",
      "contact": "https://example.com/contact",
      "themecolor": { "light": "#f5f5f5", "dark": "#1a1a1a" },
      "loc": ["footer", "sidebar"],
      "frdrank": 5
    }
  ]
}

字段值规范

  • name — 站点名称
    非空纯文本;HTML 用 lang 属性(BCP 47),JSON 用 { "value": "...", "lang": "..." }。
  • link — 站点链接
    完整 URL,协议限 http 或 https,必须含域名。
  • desc — 简介
    纯文本,可带 data-length="short" 或 data-length="long",省略表示不区分;语言标注同 name。JSON 中 desc 可为 {short, long} 对象或单一 {value, lang}。
  • cat — 标准化分类

合法值:

personal,tech,design,writing,art,life,academic,news,community,archive,indieweb,open-source,security,privacy,devops,frontend,backend,fullstack,mobile,ai,data,science,math,philosophy,history,language,education,finance,health,food,travel,photography,film,music,books,gaming,sports,craft,garden,pets,parenting,fashion,politics,environment,space,hardware,linux,windows,apple,android,web,accessibility,decentralization,selfhosted,minimalism,productivity,career,misc
  • sub — 自定义子类
    任意语言文本,通过 lang 标注语言;消费方忽略未知值。
  • logo — Logo 链接
    单一完整 URL 表示不区分;或 data-light / data-dark 各一个完整 URL。
  • feed — Feed 源链接
    完整 URL + type 属性,type 合法值:application/rss+xml、application/atom+xml、application/feed+json、application/json。可多个。
  • sitemap / shot / news / contact
    各为完整 URL,须含协议和域名。
  • themecolor — 主题色
    单一十六进制值表示不区分;或 data-light / data-dark 各一个十六进制值(# 加 3 或 6 位)。
  • loc — 展示/巡查位置
    合法值仅五个:header、footer、nav、sidebar、content。可多个。
  • frd* — 自定义扩展
    HTML:data-frd* 属性,如 data-frdrank;JSON:frd* 键,如 "frdrank"。后缀为小写字母或数字;值类型不限;消费方忽略不认识的扩展。

字段总表

HTML 类名JSON 键合法值/内容可选性
friendly / unfriendlystatusfriendly 或 unfriendly必需
id="v1.0"version"1.0"必需
—protocol"friends"必需
namename非空文本 + lang必需
linklink完整 URL(http/https)必需
descdesc文本 + lang,可带 data-length可选
catcat上述合法值,可多个可选
subsub任意语言文本 + lang可选,可多个
logologo完整 URL 或 {light,dark}可选
feedfeed完整 URL + type可选,可多个
sitemapsitemap完整 URL可选
shotshot完整 URL可选
newsnews完整 URL可选
contactcontact完整 URL可选
themecolorthemecolor十六进制或 {light,dark}可选
loclocheader/footer/nav/sidebar/content可选,可多个
data-frd*frd*自定义,后缀小写字母数字可选

发现机制

发布方式发现入口
仅 HTML页面中 class="friendly" 或 class="unfriendly" 的元素
仅 JSON<link rel="friends" type="application/json" href="/.well-known/friends.json">
两者均发布同上,HTML 与 JSON 内容应一致
此草案暂为提案性质,未在 microformats wiki 或 IANA 注册。