> [!NOTE]
> Useful information that users should know, even when skimming content.
> [!TIP]
> Helpful advice for doing things better or more easily.
> [!IMPORTANT]
> Key information users need to know to achieve their goal.
> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.
效果:
[!NOTE]
Useful information that users should know, even when skimming content.
[!TIP]
Helpful advice for doing things better or more easily.
[!IMPORTANT]
Key information users need to know to achieve their goal.
[!WARNING]
Urgent info that needs immediate user attention to avoid problems.
[!CAUTION]
Advises about risks or negative outcomes of certain actions.
一、主题配置 👀
1. 手动模式(默认)
这种模式就是当访问者第一次打开博客页面时,呈现的是亮主题。 访问者可以通过页面右上角的按钮随意切换(亮/暗/跟随系统),当切换过后,会自动在浏览器存储目前的选择,之后访问者用同一浏览器再打开博客任何页面,则自动为上次选择的模式。
2. 固定模式
2.1. 固定亮主题
2.2. 固定暗主题
二、右上角的按钮配置 👀
在首页上部的右侧有一些按钮,配置方式如下:
1. 站内链接
例如关于页面和友情链接
1.1. 添加config.json配置
1.2. 添加一个Labels标签为
about
,在你的issue里面写一个文章,然后配置Labels为about
即可。1.3. 手动全局生成一次。
2. 站外链接
如果你的
about
页面是站外的,或者想定义其他的站外链接,例如music。下面以添加music页面按钮为示例。2.1. 添加config.json配置
此处
iconList
自定义了图标的SVG,exlink
定义了外部链接的地址2.2. 手动全局生成一次。
3. SVG图标格式
使用
iconList
自定义SVG图标必须是16px
大小的,建议使用github的Octicons 图标Octicons图标链接:https://primer.style/foundations/icons/#16px 大佬自己转换的Octicons图标path列表:https://gist.github.com/Meekdai/f6375fe2740428af39d90f1afa678fdc
三、提示标签 👀
Github的语法里面有5种警报强调信息,分别是
NOTE
TIP
IMPORTANT
WARNING
CAUTION
在写文章的时候,适当使用可以提高文章的可读性使用方式:
效果:
四、折叠显示 👀
使用方式:
效果:
展开
五、文章插入html标签 👀
Github由于安全考虑,是不允许使用
iframe
等标签的,而且在issues插入的图片也会自动转换为github的地址。 为了文章的多样性,在Gmeek的v2.19
版本中添加了支持html标签的功能。使用方式:
在需要添加html标签的位置使用
code
方式,并且后面紧跟着Gmeek-html,然后才是html标签。1. 图片
Gmeek-html<img src="https://picsum.photos/400">
2. 内嵌框架iframe-网站
Gmeek-html<iframe style='border-radius:12px' src="https://music.meekdai.com/#35" width="100%" height="150px" frameborder="0" allowfullscreen="true"></iframe>
3. 内嵌框架iframe-音乐
Gmeek-html<iframe style='border-radius:12px' src='https://open.spotify.com/embed/track/0U3fV7K4WFfVRgLGEAKh3g?utm_source=generator' width='100%' height='100' frameBorder='0' allowfullscreen='' allow='autoplay; clipboard-write; encrypted-media; fullscreen; picture-in-picture' loading='lazy'></iframe>
4. 内嵌框架iframe-视频
Gmeek-html<iframe style='border-radius:12px' src="//player.bilibili.com/player.html?isOutside=true&aid=1604800941&bvid=BV1qm421M7Xs&cid=1557311907&p=1&autoplay=0" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" width="100%" height="200px"></iframe>
Gmeek-html<iframe style='border-radius:12px' width="100%" height="200px" src="https://www.youtube.com/embed/RzYO_cGqrAY?si=qO64_ABMM0jyvNUi" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
5. 其他
上面仅仅是示例了一些常用的html标签,其他html标签同样也支持,可以尝试添加到自己的文章中。
六、static文件夹使用 👀
如果需要在docs文件内上传一些自己的文件,比如图片、js、css等,所以在
v2.20
版本添加了这个功能。使用方式:
static
。static
文件内上传一些自己的文件,比如avatar.svg
文件。七、插件 👀
为了使得Gmeek的功能更加的丰富,添加了插件功能,目前已经有几个插件可以使用。
1. Vercount浏览计数
GmeekVercount.js
全站添加,只需要在config.json文件内添加配置
单个文章页添加,只需要在文章最后一行添加如下
2, TOC目录
GmeekTOC.js
全站添加,只需要在config.json文件内添加配置
单个文章页添加,只需要在文章最后一行添加如下
3. ArticleTOC目录
articletoc.js
本插件由Tiengming编写,也是一个非常不错的TOC目录插件。配置方式和上面一样,只需要替换地址为如下地址即可。
4. 灯箱插件
lightbox.js
本插件由Tiengming编写,可以放大浏览文章中的图片,适合一些图片较多的文章。
全站添加,只需要在config.json文件内添加配置
单个文章页添加,只需要在文章最后一行添加如下
5. 多插件使用
全站添加,所有文章页使用
TOC目录
和灯箱插件
,需要这样添加配置文件:单个文章页添加,单个文章使用
TOC目录
和灯箱插件
,需要这样添加配置文件:I. 单篇文章自定义参数,自定义单篇文章页面的
style
和script
II. 单篇文章多种自定义参数,可同时一起添加多种自定义参数:
III. 全局文章自定义参数,添加全局文章页面的
style
和script
,在config.json
文件中添加八、其他设置 👀
1. 导入以前的文章
如需修改发布时间,可以在文章最后一行添加如下代码。里面的时间是采用时间戳的形式,可以用如下时间形式转换网站转换。
2. 置顶博客文章
只需要
Pin issue
后,手动全局生成一次即可。3. 删除文章
只需要
Close issue
或者Delete issue
后,再手动全局生成一次即可。