Skip to content

Github Info Card

MDx 提供了多种短代码的支持,在文章中插入短代码即可调用相关功能。「Github 信息卡」是其中的一种。

基本用法

[mdx_github 属性名="属性值"][/mdx_github]

可用属性

属性名 可选值 默认值 描述
author 任意字符串 空字符串 项目作者的用户名
project 任意字符串 空字符串 仓库名称

例子

[mdx_github author="yrccondor" project="mdx"][/mdx_github]

技巧

属性都不是必须的,当没有指定属性值时将使用默认值。属性的顺序也不影响最终效果。

加载失败

如果预览信息加载失败,在信息卡的原本位置将会显示错误信息,并提供一个指向项目页面的链接。

预览

Preview