GitHubNav 使用教程

GitHubNav 是 GitHub 用户导航工具,输入用户名即可浏览其公开信息与仓库数据,支持通过 iframe 固化到自己的网页中使用。在线入口:https://JularDepick.github.io/Web-Tool/GitHubNav

固化到自己的网页

只需在合适的网站目录下新建 index.html,粘贴以下代码,并将 <username> 替换为你的 GitHub 用户名即可:

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8"/>
        <title>GitHub导航·JularDepick</title>
    </head>
    <body>
        <iframe style="width:100vw;height:100vw;border:none;margin:0;padding:0;" src="https://JularDepick.github.io/Web-Tool/GitHubNav?hidden_form=true&username=<username>&hidden_notice=true&cache=true&hidden_refresh=true&hidden_help=true&title=GitHub_个人导航&desc=浏览我的_GitHub_公开信息与仓库数据"></iframe>
    </body>
</html>

建议参数

在 https://JularDepick.github.io/Web-Tool/GitHubNav 后添加参数:

添加参数 hidden_form=true 禁用切换用户功能
添加参数 username=<你的GitHub用户名> 自动切换为你的用户展示
添加参数 title=GitHub_个人导航 和 desc=浏览我的_GitHub_公开信息与仓库数据 以使用推荐的标题和描述
添加参数 hidden_foot=true 隐藏页脚
添加参数 hidden_notice=true 隐藏API限额提示引用块
添加参数 hidden_help=true 隐藏使用教程链接
添加参数 cache=true 启用缓存,同用户名30分钟内刷新页面不重新请求API
添加参数 hidden_refresh=true 隐藏"刷新数据"按钮,启用缓存时建议同时添加,防止用户手动刷新消耗配额
添加参数 root=<你的网站主页链接> 以自定义页脚根网站指向(隐藏页脚时使用该参数无实际意义)

参数说明

参数	说明
`username`	默认展示的用户名,替换 `<username>` 即可
`hidden_form=true`	隐藏用户切换表单,固化到自己的网页时建议保留
`title`	覆盖页面标题,用 `_` 分隔的两段分别使用普通色与强调色,展示时 `_` 会替换为空格
`desc`	覆盖页面描述,展示时 `_` 会替换为空格
`hidden_foot=true`	隐藏页面底部页脚
`hidden_notice=true`	隐藏 API 限额提示引用块
`hidden_help=true`	隐藏 hero 区使用教程链接(指向 help.html)
`cache=true`	启用缓存:同用户名 30 分钟内再次加载直接读取浏览器缓存,不消耗 REST API 配额;每次请求成功后都会刷新缓存,仅启用时读取,过期或用户名不符时自动重新请求
`hidden_refresh=true`	隐藏"刷新数据"按钮
`root`	覆盖页脚根站点链接的文字与指向为该值

API 使用教程

本工具数据全部来自 GitHub 官方接口,按职责划分为两套接口,互不混用:

REST API

用途:拉取用户信息与用户仓库列表
端点:GET /users/{username}(用户信息)、GET /users/{username}/repos(仓库列表)
本工具每次刷新/查询固定消耗 2 次请求,未认证请求官方限额为 60 次/小时/IP,额度耗尽后 1 小时内无法再次使用
官方文档:https://docs.github.com/rest

raw

用途:拉取仓库 README 摘要,不消耗 REST API 配额
端点:GET https://raw.githubusercontent.com/{owner}/{repo}/{branch}/{README.md|readme.md|README.MD}
依次尝试 3 个标准文件名,单仓库总预算 10 秒,全部失败时以是否出现过 404 区分"未提供 README"与"获取超时"

作者

JularDepick

许可证

本仓库采用 MIT 许可证,详见 LICENSE。

版权信息

详见 COPYRIGHT。

README 摘要文本清洗规则

仓库卡片上的 README 摘要由原始 Markdown 依次清洗生成:

代码块整体移除,内联代码保留文本内容
HTML 注释(  )连同内容整体移除
链接标签内容移除,普通 HTML 标签仅去除标签本身
表格行、标题标记、分隔线、列表标记、引用标记、任务清单标记、链接引用定义行移除
粗体、斜体、删除线等行内标记仅去除标记符
链接清洗依次执行:嵌套链接(含图片,如 [![徽章](图片)](链接))整体移除;双层括号链接(如 [[English]](./README_en-US.md))整体移除;未闭合嵌套链接(如 [![徽章](图片](./COPYRIGHT) 缺闭合括号)连同标记移除;( 前一个字符是 ] 即视为链接(含图片语法),连同内容与标记整体移除(url 内允许成对括号);其余 [] 及其中内容直接移除
链接尾部残渣( ](... )与裸 URL 前缀( (https://... )兜底剥离,避免清洗残留
HTML 实体(如  、&)解析为对应字符
连续空白压缩为单个空格,摘要上限 520 字符
卡片高度固定,摘要区按卡片内前面区域占用后的剩余高度排布,最后一行末尾溢出时回退 2 字符并以 ... 结尾;仓库描述超出 3 行截断

返回 GitHubNav 工具页面