1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515<div align = center> <img src="https://fastly.jsdelivr.net/gh/D-Sketon/blog-img/icon.png"/> <h1>hugo-theme-reimu</h1> <img alt="version" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgithub.com%2FD-Sketon%2Fhugo-theme-reimu%2Fraw%2Fmain%2Fpackage.json&query=%24.version&label=version"> <img alt="GitHub License" src="https://img.shields.io/github/license/D-Sketon/hugo-theme-reimu"> <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/D-Sketon/hugo-theme-reimu"> <p align="center"> 💘 博麗 霊夢 💘 </p> [演示网站](https://d-sketon.github.io/hugo-theme-reimu) | [迁移指南](https://d-sketon.github.io/20241110/hexo-to-hugo-guide/) | [Change Log](https://github.com/D-Sketon/hugo-theme-reimu/blob/main/CHANGELOG.md) 简体中文 | [English](https://github.com/D-Sketon/hugo-theme-reimu/blob/main/README.en.md) <img src="https://cdn.jsdelivr.net/gh/D-Sketon/hugo-theme-reimu/images/screenshot.png"/> </div> A Hakurei Reimu style Hugo theme. Migrated from [hexo-theme-reimu](https://github.com/D-Sketon/hexo-theme-reimu). --- | framework | repository | version | stars | | ---------------------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | [Hexo](https://hexo.io/) | [hexo-theme-reimu](https://github.com/D-Sketon/hexo-theme-reimu) | <img alt="version" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgithub.com%2FD-Sketon%2Fhexo-theme-reimu%2Fraw%2Fmain%2Fpackage.json&query=%24.version&label=version"> | <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/D-Sketon/hexo-theme-reimu"> | | [Hugo](https://gohugo.io) | [hugo-theme-reimu](https://github.com/D-Sketon/hugo-theme-reimu) | <img alt="version" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgithub.com%2FD-Sketon%2Fhugo-theme-reimu%2Fraw%2Fmain%2Fpackage.json&query=%24.version&label=version"> | <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/D-Sketon/hugo-theme-reimu"> | | [Astro](https://astro.build) | [astro-theme-reimu](https://github.com/D-Sketon/astro-theme-reimu) | <img alt="version" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgithub.com%2FD-Sketon%2Fastro-theme-reimu%2Fraw%2Fmain%2Fpackage.json&query=%24.version&label=version"> | <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/D-Sketon/astro-theme-reimu"> | **欢迎提出 Issue 和 PR！** ## 特性 ### 基础功能 - ✨ 完整的博客功能 - 🔄 兼容 Hugo 0.124.0 及以上版本 - 📱 响应式布局 - 🌙 暗黑模式支持 - 🅰️ i18n 支持 ### 代码与数学 - 🖥️ 代码高亮与复制 - ➗ KaTeX / MathJax3 数学公式支持 - 📊 Mermaid 流程图支持 ### 搜索与评论 - 🔍 Algolia 搜索集成 - 💬 多评论系统支持： - Valine - Waline - Twikoo - Gitalk - Giscus - Disqus - Utterances ### 统计与分析 - 📊 文章阅读统计（Valine / Waline） - 👥 访客统计（不蒜子） ### 媒体与交互功能 - 🎵 音乐播放器支持： - Aplayer - Meting - 🖼️ 图片懒加载 - ⚡ 加载动画 - 🖱️ 鼠标特效： - 动画效果 - 灵梦鼠标指针 - 👾 Live2D / Live2D-widgets 集成 ### 导航与结构 - 📑 目录导航 - 🔄 PJAX 支持 - 🔧 ServiceWorker 实现 - 📰 RSS 订阅 ### 设计与自定义 - 🎨 图标支持： - Iconfont - FontAwesome7 - 🔗 内置短代码： - 内部链接 - 外部链接 - 友情链接 - 热力图 - 标签轮盘 - Alert块引用 - 标签页 - 照片墙 - 🎨 动态适配主题色 - ©️ 文章版权声明 - 🌐 自定义 CDN 源 / 本地配置 - 📜 自定义字体 - 🎨 分享卡片功能 ## 安装 > 纯小白可以直接使用 [hugo-reimu-template](https://github.com/D-Sketon/hugo-reimu-template)。只需 克隆仓库-修改配置 即可获得一个基本的博客！ ### 方式 1：Hugo Module（推荐） 适用于熟悉 Go 生态的用户，支持版本管理和自动更新。 ```bash hugo new site quickstart cd quickstart hugo mod init github.com/<your-github-username>/quickstart # 请替换 <your-github-username> echo 'theme = ["github.com/D-Sketon/hugo-theme-reimu"]' >> hugo.toml hugo server ``` ### 方式 2：Git Submodule 适用于希望手动管理主题版本的用户。 ```bash hugo new site quickstart cd quickstart git init git submodule add https://github.com/D-Sketon/hugo-theme-reimu.git themes/reimu echo 'theme = "reimu"' >> hugo.toml hugo server ``` 选择适合你的安装方式，即可开始使用 **Hugo Theme Reimu**！ ## 使用 <details> <summary>创建配置</summary> ### 创建配置 #### 主题配置 在外层 `config` 文件夹下创建 `_default` 文件夹，然后将主题内的 `config/_default/params.yml` 复制到 `_default` 文件夹下，此文件作为主题配置文件，可在此文件中修改主题配置 #### 数据配置 将主题内的 `config/data/` 文件夹内的所有文件复制到外层 `data` 文件夹下，此文件夹内的文件用于配置主题内的数据： - `covers.yml` 用于配置随机封面图片 - `friends.yml` 用于配置友链 - `vendor.yml` 用于配置第三方库的 CDN 源 #### 静态资源配置 主题的静态资源（favicon，头图等）位于 `static` 文件夹内，你可以在外层 `static` 文件夹下创建相应的文件夹，然后将主题内的文件复制到外层文件夹下，以覆盖主题内的默认文件 > 总之一句话，不建议直接修改主题内的文件，而是在外层创建相应的文件夹，然后将主题内的文件复制到外层文件夹下，以覆盖主题内的默认文件，这样便于主题升级 #### 语言配置 reimu 支持多语言。如果你想要使用中文，请在 `hugo.toml` 中添加如下配置 ```toml languageCode = 'zh-CN' defaultContentLanguage = 'zh-CN' [languages] [languages.zh-CN] languageName = '简体中文' weight = 1 hasCJKLanguage = true ``` </details> <details> <summary>基本结构</summary> ### 基本结构 为了保证显示正确，请参考 `_example` 在 `content` 中建立 `archives` 和 `post` 文件夹 （里面的 `_index.md` 不可省略，且注意 `post` 的 `draft` 为 `true`） #### archives - `_index.md` 用于显示归档页面，不可省略 #### post 文章请在此目录下创建，注意 `draft` 为 `true` 的文章不会显示在首页 - `_index.md` 用于忽略 `post/index.html` 的生成，不可省略 #### about\.md 关于页面 #### friend\.md 友链页面 </details> <details> <summary>头像、封面、头图和图标</summary> ### 头像、封面、头图和favicon #### 头像 头像应保存于 `static/avatar/avatar.webp`，可在 `params.yml` 中修改文件名 ```yaml avatar: "avatar.webp" ``` #### 封面 随机封面图片请参考主题内的 `data/covers.yml` 文件结构，在外层 `data` 文件夹下创建 `covers.yml` 文件，格式如下： ```yaml - https://example.com/1.jpg - https://example.com/2.jpg ``` 封面显示逻辑如下 - 如果文章的 Front matter 中包含 cover 的 url，则该文章头图和首页缩略图均显示该 url ```yaml --- title: Hello World cover: https://example.com --- ``` - 如果文章的 Front matter 中包含 cover 为 `false`，则该文章不显示头图（首页缩略图仍然是随机图片） ```yaml --- title: Hello World cover: false --- ``` - 如果文章的 Front matter 中包含 cover 为 `rgb(xxx,xxx,xxx)`，则该文章头图为对应的渐变纯色（首页缩略图仍然是随机图片） ```yaml --- title: Hello World cover: rgb(255,117,117) --- ``` - 否则首页缩略图查找 `data` 文件夹中的 `covers.yml`，并从中随机挑选图片，文章内头图查找 `params.yml` 中的 `cover` 配置 - 若上述文件/配置均不存在，则显示 `banner` 头图作为兜底 #### 头图 头图保存于 `themes/hugo-theme-reimu/static/images/banner.webp`，可在 `params.yml` 中修改路径和名字 ```yaml banner: "images/banner.webp" ``` #### Favicon favicon 保存于 `themes/hugo-theme-reimu/static/favicon.ico`，可自行覆盖替换 #### 文章总结 默认关闭，可选择在副标题或者文章开头显示文章摘要 ```yaml summary: enable: false style: 'subtitle' # 'subtitle' | 'blockquote' ``` </details> <details> <summary>侧边栏</summary> ### 侧边栏 #### 侧边栏位置 默认在右边，可在 `params.yml` 中修改 ```yaml sidebar: position: right # left | right | false menu: true # 是否显示侧边栏菜单按钮，移动端忽略 article: show_common: true # 文章页是否显示通用侧边栏，移动端忽略 ``` 此外，也可以通过文章的 front-matter 控制，其优先级高于全局配置 ```yaml --- sidebar: left # left | right | false --- ``` > 当 sidebar 设置为 false 时，侧边栏将被隐藏，此时 aplayer 播放器和 widgets 小部件将同时无法显示 #### TOC 默认开启，可在 `params.yml` 中修改 ```yaml toc: true # true | false ``` 此外，也可以通过文章的 front-matter 控制，其优先级高于全局配置 ```yaml --- toc: true # true | false --- ``` #### 社交链接 可在 `params.yml` 中配置侧边栏中的社交链接 ```yaml social: # github: https://github.com/yourname # bilibili: https://space.bilibili.com/yourname # ... ``` #### 侧边栏小部件 可在 `params.yml` 中配置侧边栏小部件 ```yaml widgets: - category # 分类 - tag # 标签 - tagcloud # 标签云 - recent_posts # 最近文章 ``` 此外，可使用如下配置对小部件进行行为配置 ```yaml category_limits: 10 # 分类数量限制 tag_limits: 10 # 标签数量限制 recent_posts_limits: 5 # 最近文章数量限制 tagcloud_limits: 20 # 标签云数量限制 ``` </details> <details> <summary>页脚</summary> ### 页脚 #### 基础信息 页脚部分允许您配置基本显示信息和统计数据 ```yaml footer: since: 2020 # 在版权信息中显示的起始年份（例如：2020-当前年份） powered: true # 是否显示版权信息 count: true # 是否显示字数统计和阅读时间信息 busuanzi: true # 是否启用不蒜子访客统计功能 ``` #### ICP 备案 对于托管在中国大陆的网站，可以根据法规要求显示ICP备案信息 ```yml icp: icpnumber: # ICP备案号 beian: # 网安备案号 recordcode: # 网安备案链接中的recordcode参数 ``` #### 萌国 ICP 备案 (v0.12.1+) [萌国 ICP 备案](https://icp.gov.moe/) ```yml moe_icp: icpnumber: # 萌国ICP备案号 ``` </details> <details> <summary>代码块</summary> ### 代码块 为保证代码块的正确显示，请保证 `hugo.toml` 中有如下配置 ```toml [markup.highlight] guessSyntax = true noClasses = false ``` 代码块同时提供了代码粘贴功能，点击代码块右上角的复制按钮即可复制代码。在 `params.yml` 中可以对复制功能进行配置。 `success` 为复制成功时的提示，`fail` 为复制失败时的提示。此外，可以配置版权声明，当复制的字符数大于 `count` 时会在复制的内容后面添加版权声明。 ```yaml clipboard: success: en: Copy successfully (*^▽^*) zh-CN: 复制成功 (*^▽^*) zh-TW: 複製成功 (*^▽^*) ja: コピー成功 (*^▽^*) fail: en: Copy failed (ﾟ⊿ﾟ)ﾂ zh-CN: 复制失败 (ﾟ⊿ﾟ)ﾂ zh-TW: 複製失敗 (ﾟ⊿ﾟ)ﾂ ja: コピー失敗 (ﾟ⊿ﾟ)ﾂ copyright: enable: false count: 50 # 大于多少字符添加版权声明 license_type: by-nc-sa # https://creativecommons.org/licenses ``` v0.2.0 添加了配置用于控制代码块的默认展开状态，`expand` 可以设置为 `true`、`false` 或数字，数字表示当代码块的行数大于该数字时默认收缩。 ```yaml code_block: expand: true # true | false | number ``` </details> <details> <summary>站内评论</summary> ### 站内评论 > 站内评论可以使用 Front matter 中的 `comments` 独立控制每篇文章是否显示评论。 > 当 `comments` 为 `false` 时不显示评论，`true` 或不填时根据 `params.yml` 的配置决定是否显示。 > 0.8.0+ 后支持多评论系统同时使用 全局评论系统配置： ```yaml comment: title: # 评论框标题 en: Leave a comment zh-CN: 说些什么吧！ zh-TW: 說些什麼吧！ ja: コメントを残す default: waline # 多评论下，默认使用的评论系统 ``` 若基于 [Valine](https://valine.js.org/) 请参考其官方文档完成 `LeanCloud` 的配置，并在 `params.yml` 中将 `valine.enable` 改为 `true`，并填入自己的 `appId` 和 `appKey` ```yaml valine: enable: true appId: "your appId" appKey: "your appKey" pageSize: 10 # comment list page size avatar: mp # gravatar style https://valine.js.org/#/avatar # lang: zh-cn # deprecated, use html.lang instead placeholder: Just go go # valine comment input placeholder(like: Please leave your footprints ) guest_info: nick,mail,link #valine comment header info recordIP: true # whether to record the IP address of the commenters highlight: true # whether to highlight the code blocks visitor: false # whether to display the number of visitors serverURLs: # leancloud server url ``` 若基于 [Waline](https://waline.js.org/) 请参考其[官方文档](https://waline.js.org/guide/get-started/)完成 `LeanCloud` 的配置，并在 `params.yml` 中将 `waline.enable` 改为 `true`，并填入自己的 `serverURL` ```yaml waline: enable: true serverURL: "your server url" locale: {} # https://waline.js.org/guide/features/i18n.html#%E8%87%AA%E5%AE%9A%E4%B9%89%E8%AF%AD%E8%A8%80 emoji: - https://unpkg.com/@waline/emojis@1.2.0/weibo - https://unpkg.com/@waline/emojis@1.2.0/alus - https://unpkg.com/@waline/emojis@1.2.0/bilibili - https://unpkg.com/@waline/emojis@1.2.0/qq - https://unpkg.com/@waline/emojis@1.2.0/tieba - https://unpkg.com/@waline/emojis@1.2.0/tw-emoji meta: - nick - mail - link requiredMeta: - nick - mail wordLimit: 0 pageSize: 10 pageview: true ``` 若基于 [twikoo](https://twikoo.js.org) 请参考其[官方文档](https://twikoo.js.org/quick-start.html)完成 腾讯云 或 Vercel 部署，并在 `params.yml` 中将 `twikoo.enable` 改为 `true`，并填入自己的 `envId` ```yml twikoo: enable: true envId: # 腾讯云环境填 envId；Vercel 环境填地址（https://xxx.vercel.app） region: ``` 若基于 [giscus](https://giscus.app/zh-CN) 请参考文档完成仓库的配置，并在 `params.yml` 中将 `giscus.enable` 改为 `true`，并填入对应的数据 ```yml giscus: enable: true repo: "your repo" repoId: "your repoId" category: "your category" categoryId: "your categoryId" mapping: mapping strict: 0 reactionsEnabled: 1 emitMetadata: 0 inputPosition: bottom ``` 若基于 [gitalk](https://gitalk.github.io/) 请参考其[官方文档](https://github.com/gitalk/gitalk?tab=readme-ov-file#usage)完成仓库的配置，并在 `params.yml` 中将 `gitalk.enable` 改为 `true`，并填入对应的数据 ```yml gitalk: enable: true clientID: "your application client ID" clientSecret: "your application client secret" repo: "your repo" owner: "repo owner" admin: "repo owner and collaborators" md5: false # 是否使用 md5 加密路径 ``` 若基于 [Disqus](https://disqus.com/) 请在 `params.yml` 中将 `disqus.enable` 改为 `true`，并填入自己的 `shortname` ```yml disqus: enable: true shortname: "your shortname" count: true # 是否启用评论数量统计 ``` 若基于 [utterances](https://utteranc.es/) 请在 `params.yml` 中将 `utterances.enable` 改为 `true`，并填入自己的 `repo` ```yml utterances: enable: true repo: owner/repo # 这里需要修改为 你的 GitHub 用户名/刚刚创建的，用户保存博客评论的 GitHub 仓库名 issue_term: title theme: github-light # 你可以使用 auto 来自动适配深色和浅色主题 ``` </details> <details> <summary>站内搜索</summary> ### 站内搜索 基于 [Algolia](https://www.algolia.com/)，请在外层 `hugo.toml` 中添加如下配置 ```toml [outputs] home = ["Algolia", "HTML", "RSS"] [outputFormats.Algolia] baseName = "algolia" isPlainText = true mediaType = "application/json" notAlternative = true ``` 这样会在 `public` 文件夹下生成 `algolia.json` 文件，用于 Algolia 搜索。接着你可以使用诸如 `atomic-algolia` 等插件将其上传到 Algolia 同时，在 `params.yml` 中将 `algolia_search.enable` 改为 `true`，并填写相关信息（**注意！这里填写的是Search-Only Key，不允许填写Admin Key！！否则可能被攻击**） ```yaml algolia_search: enable: true ``` </details> <details> <summary>数学公式</summary> ### 数学公式 请先在外层 `hugo.toml` 中添加如下配置 ```toml [markup.goldmark.extensions.passthrough] enable = true delimiters.block = [["\\[", "\\]"], ["$$", "$$"]] delimiters.inline = [["\\(", "\\)"], ["$", "$"]] ``` 并在需要使用数学公式的文章的 Front matter 中添加 `math` 为 `true` ```yaml --- math: true --- ``` > 注意不要同时开启 KaTeX 和 MathJax3 #### KaTeX 若基于 [Katex](https://github.com/KaTeX/KaTeX)，请在 `params.yml` 中将 `math.katex.enable` 改为 `true` ```yaml math: katex: enable: true ``` #### MathJax3 若基于 [MathJax3](https://www.mathjax.org/)，请在 `params.yml` 中将 `math.mathjax.enable` 改为 `true`，并可在 `options` 中添加配置（由于 Hugo 会自动将对象的key转变为全小写，所以配置需要放在一个数组中避免默认行为） ```yaml math: mathjax: enable: true options: [{}] ``` </details> <details> <summary>Mermaid</summary> ### Mermaid 流程图基于 [Mermaid](https://mermaid.js.org/#/)，请在需要使用流程图的文章的 Front matter 中添加 `mermaid` 为 `true` ```yaml --- mermaid: true --- ``` 此外，可在 `params.yml` 中对 Mermaid 进行配置 ```yaml mermaid: zoom: false # 是否启用缩放功能 ``` </details> <details> <summary>RSS</summary> ### RSS RSS 可以在 `params.yml` 中配置 ```yaml rss: limit: 10 # 输出最近的文章数量，写 -1 输出全部 showFullContent: false # 是否输出文章的完整内容 showCopyright: false # 是否输出版权声明 ``` </details> <details> <summary>Icon</summary> ### Icon Icon 默认使用本项目提供的 iconfont ```yml icon_font: 4552607_0khxww3tj3q9 ``` 如果想要继续使用 fontawesome 图标，请将 `icon_font` 设置为 `false`，此时会使用 `vendor.yml` 中对应的 fontawesome ```yml fontawesome: high_priority: - src: webcache|@fortawesome/fontawesome-free@7.1.0/css/regular.min.css integrity: sha384-4qYppzjH8EiA+cGdaubu2vL7Rk8WGiqCSj7oRuP1uwtFWkfKNHD20lPfcrbQc8dU - src: webcache|@fortawesome/fontawesome-free@7.1.0/css/solid.min.css integrity: sha384-wbMWab3UDSPm2kvIgVOn/d9KPTecgPU1+Nb3zoQrm/oVu0EkPL6IaKinjbwW0rum low_priority: - src: webcache|@fortawesome/fontawesome-free@7.1.0/css/brands.min.css integrity: sha384-KTGeC2hIMzpeQakhsmzB9bZfhCD5xZZCgI1iZH6f/O457SxzlkzTQg/WXFNoi3ih - src: webcache|@fortawesome/fontawesome-free@7.1.0/css/v5-font-face.min.css integrity: sha384-nJ1ThfldViXoLpJ6jlKcP2beas8BMbYq26SG9Hi8cH89bZi4RZ644v7helMCqJxd - src: webcache|@fortawesome/fontawesome-free@7.1.0/css/v4-font-face.min.css integrity: sha384-UlkrhOIvZxJFd4MElSUp7ow6/RUeYKi/orfCZIRRiOENFuQPIAA3T3HjYfmBRhNq ``` </details> <details> <summary>扩展功能</summary> ### 扩展功能 #### 回到顶部 默认开启 ```yaml top: enable: true position: right # left | right ``` #### 暗黑模式 默认为 `auto`，根据用户系统设置自动切换。可以设置为 `true` 或 `false` 改变默认状态 ```yaml dark_mode: # true 代表暗黑模式默认开启 # false 代表暗黑模式默认关闭 # auto 代表根据用户系统设置自动切换 enable: auto # true | false | auto ``` #### 站点统计 默认关闭，支持百度统计、谷歌统计和微软 Clarity ```yaml baidu_analytics: false google_analytics: false clarity: false ``` #### Pace 进度条 默认开启 ```yaml pace: enable: true ``` #### Firework 鼠标特效 默认开启 ```yaml firework: enable: true disable_on_mobile: false # 是否在移动端禁用，可以提高性能 options: # mouse-firework 配置项 ``` 具体配置请查看 [mouse-firework](https://github.com/D-Sketon/mouse-firework) #### PJAX 默认关闭 ```yaml pjax: enable: false ``` #### ServiceWorker 默认关闭 ```yaml service_worker: enable: false ``` #### Live2D 默认关闭 ```yaml live2d: enable: false position: left # left | right ``` #### Live2D Widgets 默认关闭 ```yaml live2d_widgets: enable: false position: left # left | right ``` #### Reimu 鼠标指针 默认开启 ```yml reimu_cursor: true ``` #### 响应式头图 默认关闭，打开后并提供对应尺寸的图片和媒体查询可以在一定程度上提高移动端的 LCP ```yml banner_srcset: enable: false srcset: - src: "images/banner-600w.webp" media: "(max-width: 479px)" - src: "images/banner-800w.webp" media: "(max-width: 799px)" - src: - "/images/banner.avif" - "/images/banner.webp" # 支持数组形式的 fallback media: "(min-width: 800px)" ``` #### Quicklink 默认开启，打开后可以在用户停留在页面时预加载链接，提高用户体验 ```yml quicklink: enable: true timeout: 3000 # 预加载超时时间 priority: true # 是否优先加载 ignores: [] # 忽略的链接，仅支持字符串数组 ``` #### 文章版权声明 默认关闭 ```yml article_copyright: enable: false # 是否展示版权卡片？ content: author: # true | false 版权卡片展示作者？ link: # true | false 版权卡片展示链接？ title: # true | false 版权卡片展示标题？ date: # true | false 版权卡片展示创建日期？ updated: # true | false 版权卡片展示更新日期？ license: # true | false 版权卡片展示协议？ license_type: by-nc-sa # https://creativecommons.org/licenses ``` 此外，也可以通过文章的 front-matter 控制，其优先级高于全局配置 ```yaml --- copyright: true # 是否展示版权卡片？ --- ``` #### 文章过期提醒 默认关闭 ```yml outdate: enable: false daysAgo: 180 # 多少天前的文章算过期 message: en: This article was last updated on {time}. Please note that the content may no longer be applicable. zh-CN: 本文最后更新于 {time}，请注意文中内容可能已不适用。 zh-TW: 本文最後更新於 {time}，請注意文中內容可能已不適用。 ja: この記事は最終更新日：{time}。記載内容が現在有効でない可能性がありますのでご注意ください。 ``` #### 赞助 默认关闭 ```yml sponsor: enable: false # 是否展示赞助二维码？ tip: # 赞助提示 zh-CN: 请作者喝杯咖啡吧 zh-TW: 請作者喝杯咖啡吧 en: Buy me a coffee ja: コーヒーを買ってください icon: url: "../images/taichi.png" # 赞助图标，相对于 css/main.css 的路径，所以需要向上一级才能找到 images 文件夹 rotate: true # 是否旋转图标 mask: true # 是否将图片作为遮罩（即只显示 png 图片的轮廓） qr: - name: 支付宝 # 二维码名称 src: "sponsor/alipay.jpg" # 示例二维码路径，位于 static/sponsor/aliapy.jpg ``` 此外，也可以通过文章的 front-matter 控制，其优先级高于全局配置 ```yaml --- sponsor: true # 是否展示赞助二维码？ --- ``` #### 音乐播放器（v0.4.0+） > 使用前建议先打开 Pjax，否则会出现播放器自动暂停的问题 使用Aplayer + Meting（可选）默认关闭 ##### 音乐播放器位置（v0.12.1+） 默认在 sidebar 之后 ```yml player: position: before_sidebar # before_sidebar / after_sidebar / after_widget ``` ##### 纯Aplayer 将 `player.aplayer.enable` 设置为 `true`，并在 `player.aplayer.options` 中参考 [Aplayer Docs](https://aplayer.js.org/#/home?id=options) 进行配置 ```yml player: aplayer: enable: true options: audio: [] # audio list fixed: autoplay: loop: order: preload: volume: mutex: listFolded: lrcType: ``` ##### Aplayer + Meting 同时将 `player.aplayer.enable` 和 `player.meting.enable` 设置为 `true`，并在 `player.meting.options` 中参考 [Meting Docs](https://github.com/metowolf/MetingJS?tab=readme-ov-file#option) 进行配置，`player.aplayer.options` 为 Aplayer 配置 ```yml player: aplayer: enable: true options: audio: [] # this option will be overwritten by meting fixed: autoplay: loop: order: preload: volume: mutex: listFolded: lrcType: meting: enable: true meting_api: # custom api options: id: server: type: auto: ``` #### 分享链接/卡片（v0.5.0+） 默认关闭，目前支持 `facebook`、`twitter`、`linkedin`、`reddit`、`weibo`、`qq`、`weixin`。 ```yml share: # - facebook # - twitter # - linkedin # - reddit # - weibo # - qq # - weixin ``` `weixin` 状态下会生成带有二维码的分享卡片，可保存到本地后分享到微信朋友圈（注意，当文章封面存在跨域问题时无法使用 html-to-image 正确生成含图片的卡片！） #### 首页目录卡片（v0.6.0+） 默认关闭，打开后可以在首页展示目录卡片，用于代替 widget 中的目录 ```yml home_categories: enable: false # 是否展示首页目录卡片？ content: - categories: # 目录名称，字符串类型 cover: # 卡片封面，不填则使用随机封面 - categories: cover: ``` #### 注入器（v0.6.3+） 用于注入自定义代码，其效果和 [Hexo#Injector](https://hexo.io/api/injector) 类似，支持 `head`、 `body` 和 `sidebar` 注入 ```yaml injector: head_begin: # 在 <head> 标签后注入代码 head_end: # 在 </head> 标签前注入代码 body_begin: # 在 <body> 标签后注入代码 body_end: # 在 </body> 标签前注入代码 sidebar_begin: # 在 <aside> 标签后注入代码 sidebar_end: # 在 </aside> 标签前注入代码 ``` #### Pangu 自动分割 （v0.7.0+） 默认关闭，自动替你在文章中所有的中文字和半形的英文、数字、符号之间插入空白。 ```yml pangu: enable: false ``` #### 三角徽标（v0.13.2+） 默认关闭，打开后会在右上角展示三角徽标，支持自定义链接和图标 ```yml triangle_badge: enable: false icon: github # 与 social 配置里的 icon 相同 link: https://github.com/D-Sketon/hexo-theme-reimu ``` </details> <details> <summary>内置shortcode</summary> ### 内置shortcode #### friendLink 友链卡片 ```markdown {{< friendsLink >}} ``` 无参数，直接读取 `data/friends.yml` 文件 #### postLinkCard 内链卡片 (不推荐，建议使用 link) ```markdown {{<postLinkCard path="?" cover="?" escape="?" >}} ``` 不推荐使用，建议使用 `link` shortcode 代替 其中第一个参数为文章的 `path`；第二个参数（可选）为卡片展示的封面，如果设置为 `auto` 则自动使用博客的 `banner`；第三个参数（可选，`true | false`）表示文章标题是否被转义 #### externalLinkCard 外链卡片 (不推荐，建议使用 link) ```markdown {{<externalLinkCard title="?" link="?" cover="?">}} ``` 不推荐使用，建议使用 `link` shortcode 代替 其中第一个参数为文章的标题；第二个参数为文章的外部链接，第三个参数（可选）为卡片展示的封面，如果设置为 `auto` 则自动使用缺省封面 #### heatMapCard 文章热力图 (v0.8.0+) ```markdown {{< heatMapCard levelStandard="?" >}} ``` 其中第一个参数为热力图的等级标准（按照文章字数分级），默认为 `"1000,5000,10000"` #### tagRoulette 标签轮盘 (v0.12.0+) ```markdown {{< tagRoulette tags="?" icon="?" >}} ``` tagRoulette 是一个互动元素，提供随机标签展示功能，点击按钮后会从预定义的标签池中随机抽取并展示一个标签。 - tags：可选参数，指定标签池，多个标签用英文逗号(,)分隔；未提供时默认使用几个示例标签，例如：tags="记忆衰退,表达欲丧失,更加怠惰,无感,好想睡觉" - icon：可选参数，自定义触发按钮的图标，默认使用：🕹️（游戏手柄emoji），可替换为任何emoji或文字，如 🎲、🎯、🔄 等 #### alertBlockquote 块引用 (v0.12.1+) ```markdown {{< alertBlockquote type="?" >}} Your content here {{</alertBlockquote>}} ``` 适用于 Hugo v0.132.0 以下版本不能使用 Hugo Blockquote render hooks 的场景。 其中第一个参数为块引用的类型，可选参数为：`note`、`tip`、`important`、`warning`、`danger` #### link 链接卡片 (v0.14.0+) ```markdown {{< link title="?" link/path="?" cover="?" escape="?" >}} ``` externalLinkCard 和 postLinkCard 的升级版，推荐使用。 - title：链接卡片的标题，内链时可省略，自动使用文章标题 - link/path：链接的 URL 地址，为保证兼容性，`link` 和 `path` 均可使用，二者效果相同 - cover：卡片展示的封面，如果设置为 `auto` 则自动使用博客的 `banner` 或缺省封面 - escape：文章标题是否被转义，取值`true | false`，默认为 `true` #### tabs 标签页 (v0.14.0+) ```markdown {{< tabs [activeTab] ["center"] >}} <!-- tabName --> Tab content <!-- tabName --> Tab content {{< /tabs >}} ``` 从 next, volantis, stellar 主题借鉴而来，支持在文章中创建标签页切换效果。 - activeTab：可选参数，指定默认激活的标签页下标，从 1 开始计数，默认为 1 - "center"：可选参数，指定标签页标题居中显示，默认左对齐 - tabName：每个标签页的标题，必须用 `<!-- tabName -->` 包裹，支持使用 `@` + 图标十六进制代码 展示图标，例： - 标题 `<!-- 标题 -->` - 图标 `<!-- @e60c -->` - 图标+标题 `<!-- 标题@e60c -->` #### gallery 照片墙 (v0.14.0+) ```markdown {{< gallery >}}   ... {{</gallery>}} ``` 将多张图片以照片墙的形式展示出来，支持自动排列和响应式布局。 #### grid 网格布局 (v0.14.1+) ```markdown {{< grid width=? col=? >}} <!-- cell --> 内容1 <!-- cell --> 内容2 <!-- cell --> 内容3 {{< /grid >}} ``` 将内容以网格的形式展示出来，支持响应式布局。 - width：可选参数，设置最小列宽，如 `300` 表示最小列宽为 300px，默认值为 `240` - col：可选参数，设置固定列数，如 `3` 表示固定 3 列布局，默认值为自适应列数 - 使用 `<!-- cell -->` 分隔每个网格单元，每个单元的内容会被独立渲染 #### details 折叠面板 (v0.14.1+) ```markdown {{< details summary="?" >}} 内容 {{< /details >}} ``` 在文章中创建折叠面板。 - summary：可选参数，设置折叠面板的标题 </details> <details> <summary>自定义主题</summary> ### 自定义主题 #### 动态适配主题色 (v0.8.0+ 实验性功能) 默认关闭，打开后会基于 Google's Material You 的设计规范根据文章头图的主色调动态生成主题色 ```yml material_theme: enable: false # true | false ``` > 注意：当开启该功能时，会在 banner 的 img 元素上添加 `crossorigin="anonymous"` 属性，以获取图片的主色调，所以请确保你的图片服务器支持跨域访问，或使用第三方图片代理。 #### 手动定制主题颜色 hugo-theme-reimu 主题支持通过 CSS 变量定制主题颜色，你可以通过修改 `:root` 伪类下的 CSS 变量来定制你的主题颜色。 v0.9.0 对外暴露了 `internal_theme` 配置用于定制主题颜色 token ```yaml internal_theme: light: --red-0: "#ff0000" --red-1: "#ff5252" --red-2: "#ff7c7c" --red-3: "#ffafaf" --red-4: "#ffd0d0" --red-5: "#ffecec" --red-5-5: "#fff3f3" --red-6: "#fff7f7" --color-red-6-shadow: "rgba(255, 78, 78, 0.6)" --color-red-3-shadow: "rgba(255, 78, 78, 0.3)" --highlight-nav: "#f5f5f5" --highlight-scrollbar: "#d6d6d6" --highlight-background: "#fdfdfd" --highlight-selection: "#e9e9e988" --highlight-foreground: "#24292e" --highlight-comment: "#7d7d7d" --highlight-red: "#d73a49" --highlight-orange: "#e36209" --highlight-yellow: "#cb911d" --highlight-green: "#22863a" --highlight-aqua: "#005cc5" --highlight-blue: "#032f62" --highlight-purple: "#6f42c1" --highlight-deletion: "#b31d28" --highlight-deletion-bg: "#ffeef0" --highlight-addition: "#22863a" --highlight-addition-bg: "#f0fff4" dark: --red-4: "rgba(255, 208, 208, 0.5)" --red-5: "rgba(255,228,228,0.15)" --red-5-5: "rgba(255,236,236,0.05)" --red-6: "rgba(255, 243, 243, 0.2)" --highlight-nav: "#222830" --highlight-scrollbar: "#454d59" --highlight-background: "#1e2027" --highlight-selection: "#51515155" --highlight-foreground: "#c9d1d9" --highlight-comment: "#8b949e" --highlight-red: "#ff7b72" --highlight-orange: "#ffa657" --highlight-yellow: "#ffcc66" --highlight-green: "#7ee787" --highlight-aqua: "#a5d6ff" --highlight-blue: "#79c0ff" --highlight-purple: "#d2a8ff" --highlight-deletion: "#ffa198" --highlight-deletion-bg: "#490202" --highlight-addition: "#7ee787" --highlight-addition-bg: "#04260f" ``` #### 自定义字体 可通过以下配置定义谷歌字体： ```yaml # https://fonts.google.com/ font: enable: true # 是否启用谷歌字体 article: - Mulish - Noto Serif SC code: # - Ubuntu Mono # - Source Code Pro # - JetBrains Mono ``` v0.2.0 添加了 `local_font` 配置用于定义本机字体，其优先级比谷歌字体低： ```yaml local_font: article: - "-apple-system" - PingFang SC - Microsoft YaHei - sans-serif code: - Menlo - Monaco - Consolas - monospace ``` v0.9.0 添加了 `custom_font` 配置用于定义自定义字体，其优先级最高： ```yaml custom_font: enable: true article: - css: https://fontsapi.zeoseven.com/292/main/result.css # 字体 css 文件 name: LXGW WenKai # 字体名称 code: ``` #### 定制图标 ##### 头部 / 侧边栏图标 v0.1.0 的 `menu` 配置的结构发生了变化，允许用户自定义 icon。icon 为空时默认使用太极图标，你可以填写一个十六进制的数字来自定义 icon，同时支持 fontawesome，icon font 和 `false`。 v0.10.2 icon 支持图片路径，如 `/avatar/avatar.webp`。 ```yaml menu: - name: home url: / icon: # 不填默认使用太极图标 - name: archives url: /archives icon: f0c1 # 你可以填写一个十六进制的数字来自定义 icon，支持 fontawesome 和 icon font，如果填写 false 则不显示图标 - name: about url: /about icon: - name: friend url: /friend icon: ``` ##### 底部 / 回到顶部 / 赞助图标 v0.1.0 的 `footer`、`top`、`sponsor` 配置均增加了 `icon` 配置用于自定义图标。 - `url` 为图标的路径，相对于 `css/main.css` 的路径，所以需要向上一级才能找到 images 文件夹。 - `rotate` 为是否旋转图标，默认为 `true`。 - `mask` 是否将图片作为遮罩（即只显示 png 图片的轮廓），默认为 `true`。 ```yaml footer: icon: url: "../images/taichi.png" # 相对于 css/main.css 的路径，所以需要向上一级才能找到 images 文件夹，支持 false 以隐藏图标 rotate: true mask: true top: icon: url: "../images/taichi.png" rotate: true mask: true sponsor: icon: url: "../images/taichi.png" # 支持 false 以隐藏图标 rotate: true mask: true ``` ##### 加载图标 v0.1.0 的 `preloader` 配置增加了 `icon` 配置用于自定义图标。icon 为空时默认使用内链的 svg（保证首屏加载速度），你可以填入一个链接来自定义加载图标。 不建议使用过大的图标，以免影响加载速度。 ```yaml preloader: enable: true text: zh-CN: 少女祈祷中... zh-TW: 少女祈禱中... en: Loading... ja: 少女祈祷中... icon: # 不填默认使用内链的svg（保证首屏加载速度），你可以填入一个链接来自定义加载图标，如 '/images/taichi.png' rotate: true ``` ##### 锚点图标 v0.1.0 增加了 `anchor_icon` 配置用于自定义锚点图标，默认使用 `#` 图标，你可以填写一个十六进制的数字来自定义 icon，同时支持 fontawesome 和 icon font。 ```yaml anchor_icon: # 不填默认使用 # 图标 ``` v0.11.0 `anchor_icon` 支持传递 `false` 以隐藏锚点图标 ##### 鼠标图标（v0.5.0+） v0.5.0 增加了 `reimu_cursor.cursor` 配置用于自定义鼠标图标，你可以填写一个相对于 `css/main.css` 的路径来自定义鼠标图标。 ```yaml reimu_cursor: enable: true cursor: default: ../images/cursor/reimu-cursor-default.png pointer: ../images/cursor/reimu-cursor-pointer.png text: ../images/cursor/reimu-cursor-text.png ``` #### 自定义滚动动画 基于 [AOS.js](https://github.com/D-Sketon/aos.js) 实现的滚动动画效果，默认为 `true`，可以通过以下配置开启或关闭，并为不同页面设置不同的动画效果。 ```yaml animation: enable: true options: header: home: article: archive: ``` **可用动画效果：** - **Fade**: fade, fade-up, fade-down, fade-left, fade-right, fade-up-right, fade-up-left, fade-down-right, fade-down-left - **Flip**: flip-up, flip-down, flip-left, flip-right - **Slide**: slide-up, slide-down, slide-left, slide-right - **Zoom**: zoom-in, zoom-in-up, zoom-in-down, zoom-in-left, zoom-in-right, zoom-out, zoom-out-up, zoom-out-down, zoom-out-left, zoom-out-right #### 自定义样式 可以通过修改 `layout.max_width` 来定制主要内容区域的最大宽度，默认为 `1350px`。 ```yaml layout: max_width: 1350px # 主要内容区域的最大宽度 ``` </details> <details> <summary>Vendor</summary> ### Vendor `vendor` 用于存放一些第三方资源，如 fontawesome、iconfont、katex、mathjax 等。 hugo-theme-reimu 的 `vendor` 结构非常灵活，其支持以下几种形式： - `:cdn|:package@:version/:file`：使用 CDN 加速，如 `cdn_jsdelivr_gh|katex@0.13.11/dist/katex.min.css`，`:cdn`可在 `vendor` 中自行配置。目前自带以下 CDN 源： ```yaml cdn_jsdelivr_gh: https://cdn.jsdelivr.net/gh/ # 仅针对github加速 cdn_jsdelivr_npm: https://cdn.jsdelivr.net/npm/ # 仅针对npm加速 fastly_jsdelivr_gh: https://fastly.jsdelivr.net/gh/ # 仅针对github加速 fastly_jsdelivr_npm: https://fastly.jsdelivr.net/npm/ # 仅针对npm加速 unpkg: https://unpkg.com/ # 仅针对npm加速 webcache: https://npm.webcache.cn/ # 仅针对npm加速 local: /resources/ # 本地资源 ``` 用户可根据网络状况自行切换 CDN 源。 - `https://:path` 开头：直接使用绝对链接，如 `https://cdn.jsdelivr.net/npm/katex@0.13.11/dist/katex.min.css` - `:path` 开头：本地资源，你可以把资源放在 `static` 文件夹下，然后使用诸如 `katex.min.css` 的路径引用 此外，`vendor` 还支持 SRI 校验，你可以在 `vendor` 中使用 `SHA-384` 用于校验资源的完整性，如： ```yaml js: clipboard: # 使用 SRI 校验 src: webcache|clipboard@2.0.11/dist/clipboard.min.js integrity: sha384-J08i8An/QeARD9ExYpvphB8BsyOj3Gh2TSh1aLINKO3L0cMSH2dN3E22zFoXEi0Q lazysizes: webcache|lazysizes@5.3.2/lazysizes.min.js # 不使用 SRI 校验 ``` 以上两种形式均支持，建议对外部 CDN 资源使用 SRI 校验，以确保资源的完整性。 </details> <details> <summary>Front-matter 字段</summary> ### Front-matter 字段 | meta | 描述 | 类型 | 取值逻辑 | 版本 | | ----------- | ----------------------------------------------- | ---------------------------- | ------------------ | --------- | | title | 标题 | `string` | - | Hugo 内置 | | date | 文章创建时间 | `datetime` | - | Hugo 内置 | | lastmod | 文章最后修改时间 | `datetime` | - | Hugo 内置 | | summary | 文章摘要 | `string` | - | Hugo 内置 | | weight | 文章权重，用于排序/置顶 | `int` | - | Hugo 内置 | | categories | 文章分类 | `string[]` | - | 0.0.1 | | tags | 文章标签 | `string[]` | - | 0.0.1 | | description | 文章描述 | `string` | - | 0.0.1 | | mermaid | 是否开启 mermaid，需配合 `mermaid` 配置一起使用 | `boolean` | `false` | 0.0.1 | | math | 是否开启 LaTeX，需配合 `math` 配置一起使用 | `boolean` | `false` | 0.0.1 | | link | 用于文章直接指向外部链接 | `string` | - | 0.0.1 | | copyright | 是否开启文章版权声明 | `boolean` | 不传默认走全局配置 | 0.0.1 | | sponsor | 是否开启文章赞助 | `boolean` | 不传默认走全局配置 | 0.0.1 | | comments | 是否开启文章评论 | `boolean` | 不传默认走全局配置 | 0.0.1 | | photos | 文章照片墙 | `string[]` | - | 0.0.1 | | sidebar | 文章侧边栏位置 | `false \| 'left' \| 'right'` | 不传默认走全局配置 | 0.5.0 | | toc | 是否开启文章目录 | `boolean` | 不传默认走全局配置 | 0.7.0 | | outdated | 文章是否过期 | `boolean` | 不传默认走全局配置 | 0.13.1 | | author | 文章作者，用于文章版权和分享卡片 | `string` | 不传默认走全局配置 | 0.13.2 | | keywords | 文章关键词 | `string[] \| string` | 不传默认走全局配置 | 0.13.4 | </details> ## 贡献者 [](https://github.com/D-Sketon/hugo-theme-reimu/graphs/contributors) ## 赞助 💘 [爱发电-afdian](https://afdian.tv/a/dsketon) ## Star History [](https://www.star-history.com/#D-Sketon/hugo-theme-reimu&type=date&legend=top-left) ## 许可 MIT