浏览代码

如何使用图标

Naruto 1 年之前
父节点
当前提交
794b4a9e41
共有 4 个文件被更改,包括 71 次插入10 次删除
  1. 1 1
      requirements.txt
  2. 3 0
      test1/docs/1.md
  3. 6 0
      test1/docs/about.md
  4. 61 9
      test1/mkdocs.yml

+ 1 - 1
requirements.txt

@@ -3,4 +3,4 @@ mkdocs-material
 mkdocs-material-extensions
 mkdocs-minify-plugin
 pymdown-extensions
-python-markdown-math
+python-markdown-math

+ 3 - 0
test1/docs/1.md

@@ -1,5 +1,8 @@
 # 模版1
 
+<span class="a-heart"></span>
+
+:fa-icon_name:
 ------
 
 title: demo

+ 6 - 0
test1/docs/about.md

@@ -1,5 +1,11 @@
 # 开源文档生成工具介绍
 
+<span class="fas fa-heart"></span> This is a heart icon.
+
+:fa-github: This is a GitHub icon.
+
+
+
 ## 简介
 
 本文介绍了一款开源的文档生成工具,类似于 MkDocs,它可以帮助您轻松地创建漂亮的文档网站。

+ 61 - 9
test1/mkdocs.yml

@@ -4,26 +4,28 @@ site_url: https://u.ltwit.com     # 文档站点的 URL
 
 # 主题设置    material\readthedocs\mkdocs
 theme:                 # 使用的主题,可以是内置主题或自定义主题
-
   name: material         # 主题名称
-
   language: zh          # 语言
-  logo: logo.png        # book的logo(文章标题的logo)
-#  logo: logo.png        # book的logo(文章标题的logo)
+  # logo: logo.png         # book的logo(文章标题的logo)
+  # logo:        # book的logo(文章标题的logo)
   homepage: https://u.ltwit.com
   favicon: logo.png     # ico图标(网站图标)
-
+  includes:
+    - fontawesome
   features:
     - header.autohide         # 自动隐藏导航栏
     - navigation.tabs         # 独立上面导航栏
     - navigation.footer       # 上一篇、下一篇显示
 
+#例如 "fab fa-facebook" 表示 Brands 中的 Facebook 图标,"fas fa-heart" 表示 Solid 中的心形图标
+  #https://fontawesome.com/search?o=r&m=free        fontawesome/brands    fontawesome/solid
 
   icon:
-    previous: fontawesome/solid/angle-left
-    next: fontawesome/solid/angle-right
+    previous: fontawesome/solid/caret-left
+    next: fontawesome/solid/caret-right
     top: material/lightbulb
-
+    #  logo: logo.png         # book的logo(文章标题的logo)
+    logo: fontawesome/solid/award
   # (调色板)白天晚上切换
   palette:
     # Palette toggle for automatic mode(自动)
@@ -63,8 +65,58 @@ extra:
   generator: false            # 去掉Made with Material for MkDocs
 
   social:                     # 社交连接
-    - icon: fontawesome/brands/mastodon
+    - icon: fontawesome/brands/weixin
+      link: https://doc.grd.net.cn/
+      name: G.R.Doc
+    - icon: fontawesome/brands/steam
       link: https://doc.grd.net.cn/
+      # 邮箱
+    - icon: fontawesome/solid/paper-plane
+      link: mailto:<sever@ltwit.com>
+
+
+
+# 插件
+plugins:
+  - search
+#  - offline
+#  - privacy
+
+
+
+
+
+
+# 所使用的Markdown扩展————一般不需要改动
+markdown_extensions:
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  # 支持emoji表情
+  - pymdownx.emoji:
+      emoji_index: !!python/name:pymdownx.emoji.twemoji
+      emoji_generator: !!python/name:pymdownx.emoji.to_svg
+  - pymdownx.inlinehilite
+  - pymdownx.magiclink
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.superfences
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tabbed
+  - pymdownx.tilde
+  - admonition
+  - mdx_math:
+      enable_dollar_delimiter: True
+
+
+
+
+
+
+