当前位置: 首页 > news >正文

4.MkDocs样式

学习

Admonitions(警告) - Material for MkDocs (wdk-docs.github.io)

提示 - Material for MkDocs 中文文档 (llango.com)

Buttons(按钮) - Material for MkDocs (wdk-docs.github.io)

建议去看这些网站,更为详细。


常用功能

便利贴

image

开启

markdown_extensions:- admonition #便利贴- pymdownx.details #块折叠- pymdownx.superfences #块嵌套

语法格式

!!! <样式> ["标题"]内容段落。

触发条件:用三个英文感叹号!!!​表示使用便利贴

样式:支持note、tip、Info等十多个样式。

标题样式:不写标题是默认,写""​是无标题。​​

范围:从!!!​起到第一个不缩进的行结束。

!!! tip示例文字:Admonition 扩展是标准 Markdown 库的一部分,与 Material for MkDocs 集成,可以通过以下方式启用:mkdocs.yml

样式预览

image

更多样式参考附录


Annotations(注解)

开启

markdown_extensions:- attr_list- md_in_html- pymdownx.superfences

演示

recording

按钮

开启

markdown_extensions:- attr_list # 按钮- pymdownx.emoji: # 图标、emojiemoji_index: !!python/name:materialx.emoji.twemojiemoji_generator: !!python/name:materialx.emoji.to_svg

语法

  • 默认按钮[标题](URL){按钮样式}

  • 带图标的按钮[标题 :图标样式:](URL){按钮样式}

是不是眼熟?就是在md的链接语法上添加了样式。示例

普通按钮
markdown [按钮标题](跳转URL){ .md-button } 主按钮
markdown [按钮标题](跳转URL){ .md-button .md-button--primary }带图标的按钮
markdown [按钮标题 :fontawesome-solid-paper-plane:](URL){: .md-button .md-button--primary }

演示(只能在静态网站中展示,CSDN等平台不支持)

普通按钮

灵魂io - 测试站{ .md-button }

主按钮

灵魂io - 测试站{ .md-button .md-button–primary }

带图标的按钮

灵魂io - 测试站 :fontawesome-solid-paper-plane:{ .md-button .md-button–primary }


代码块

启用

markdown_extensions:- pymdownx.highlight:  # 代码高亮anchor_linenums: true- pymdownx.inlinehilite- pymdownx.snippets- pymdownx.superfences- pymdownx.keys # 样式:键盘按键

代码块标题

image

效果

image

注释折叠、展开

image

效果

recording

代码块选项卡(用的是选项卡功能,不是代码块功能)

recording

高亮指定的行

image

键盘样式

image

以及导入外部文件

选项卡

开启

选项卡

markdown_extensions:- pymdownx.superfences- pymdownx.tabbed:alternate_style: true 

选项卡链接

theme:features:- content.tabs.link

写法 从===​开始,内容要缩进,遇到===​则合并选项卡,遇到既不是===​又不是缩进​的行则结束。

image

效果

recording

!!! note “选项卡的范围”
从第一个===​ 开始,缩进的行、空行、以===​ 开头的行都属于选项卡!


预览(仅支持静态网站,CSDN等平台不支持)

=== “C”

‍```c  
#include <stdio.h>int main(void) {  printf("Hello world!\n");  return 0;  
}  
‍```

=== “C++”

‍```c++  
#include <iostream>int main(void) {  std::cout << "Hello world!" << std::endl;  return 0;  
}  
‍```

=== “Tab 1”
Markdown content.

Multiple paragraphs.

=== “Tab 2”
More Markdown content.

- list item a  
- list item b

=== “Not Me”
Markdown content.

Multiple paragraphs.

===+ “Select Me”
More Markdown content.

- list item a  
- list item b

=== “Not Me Either”
Another Tab


清单

开启

markdown_extensions:- pymdownx.tasklist:         # 开启功能clickable_checkbox: true # 允许打勾和取消,但不是持续的。custom_checkbox: true    # 将task的方框修改为圆形。

编写

image

默认效果

image

custom_checkbox 效果

image

相关文章:

  • 北京网站建设多少钱?
  • 辽宁网页制作哪家好_网站建设
  • 高端品牌网站建设_汉中网站制作
  • 『C + ⒈』‘\‘
  • [ABC275A] Find Takahashi 题解
  • 基于go 1.19的站点模板爬虫
  • 记录一次排查api接口不通的问题
  • NI SCXI-1001 模块处理器控制器
  • 【work】AI八股-神经网络相关
  • 骏网一卡通之类的游戏卡有什么用?
  • kettle中调用restful接口时的SSL信任证书问题
  • cesium 雷达扫描
  • go获取正在运行的函数并及时捕获panic
  • ARM/Linux嵌入式面经(十四):ARM体系架构基础知识
  • 人与机器的协同是强弱系统的互补行为
  • 通过Spring Boot结合实时流媒体技术对考试过程进行实时监控
  • 数据结构 实验 3
  • Apache部署与配置
  • 【comparator, comparable】小总结
  • Angular 响应式表单之下拉框
  • Bootstrap JS插件Alert源码分析
  • CSS中外联样式表代表的含义
  • ECMAScript 6 学习之路 ( 四 ) String 字符串扩展
  • IDEA常用插件整理
  • js正则,这点儿就够用了
  • puppeteer stop redirect 的正确姿势及 net::ERR_FAILED 的解决
  • spring boot下thymeleaf全局静态变量配置
  • tab.js分享及浏览器兼容性问题汇总
  • 对话:中国为什么有前途/ 写给中国的经济学
  • 给初学者:JavaScript 中数组操作注意点
  • 关于Android中设置闹钟的相对比较完善的解决方案
  • 想晋级高级工程师只知道表面是不够的!Git内部原理介绍
  • 【干货分享】dos命令大全
  • NLPIR智能语义技术让大数据挖掘更简单
  • ​经​纬​恒​润​二​面​​三​七​互​娱​一​面​​元​象​二​面​
  • # Swust 12th acm 邀请赛# [ K ] 三角形判定 [题解]
  • #HarmonyOS:Web组件的使用
  • #调用传感器数据_Flink使用函数之监控传感器温度上升提醒
  • (2024,LoRA,全量微调,低秩,强正则化,缓解遗忘,多样性)LoRA 学习更少,遗忘更少
  • (Bean工厂的后处理器入门)学习Spring的第七天
  • (C语言)fgets与fputs函数详解
  • (react踩过的坑)antd 如何同时获取一个select 的value和 label值
  • (编程语言界的丐帮 C#).NET MD5 HASH 哈希 加密 与JAVA 互通
  • (过滤器)Filter和(监听器)listener
  • (十八)三元表达式和列表解析
  • (转载)跟我一起学习VIM - The Life Changing Editor
  • (轉貼) 2008 Altera 亞洲創新大賽 台灣學生成果傲視全球 [照片花絮] (SOC) (News)
  • .net Application的目录
  • .NET CORE 第一节 创建基本的 asp.net core
  • .NET delegate 委托 、 Event 事件,接口回调
  • .NET 分布式技术比较
  • .NET(C#、VB)APP开发——Smobiler平台控件介绍:Bluetooth组件
  • @DataRedisTest测试redis从未如此丝滑
  • @FeignClient 调用另一个服务的test环境,实际上却调用了另一个环境testone的接口,这其中牵扯到k8s容器外容器内的问题,注册到eureka上的是容器外的旧版本...
  • [ Linux Audio 篇 ] 音频开发入门基础知识
  • [2019.2.28]BZOJ4033 [HAOI2015]树上染色
  • [ACM独立出版] 2024年虚拟现实、图像和信号处理国际学术会议(VRISP 2024,8月2日-4)
  • [AI aider] 打造终端AI搭档:Aider让编程更智能更有趣!