---
title: Readme-Guide
canonical_url: "https://www.modelscope.cn/models/xishan01/Readme-Guide"
md_url: "https://www.modelscope.cn/models/xishan01/Readme-Guide.md"
repository: xishan01/Readme-Guide
last_updated: 2026-11-02
pipeline_tag: image-text-to-text
tasks:
- image-text-to-text
library_name:
- other
frameworks:
- other
downloads: 0
stars: 0
---
# Readme-Guide
> Readme-Guide - xishan01 在 ModelScope 开源的模型。本仓库用于回归模型 README 的 Markdown 渲染能力，每节标注「预期」，便于逐项目检。
- **Repository**: xishan01/Readme-Guide
- **Tasks**: image-text-to-text
- **Downloads**: 0
- **Stars**: 0
- **Last updated**: 2026-11-02
Source: https://www.modelscope.cn/models/xishan01/Readme-Guide
---
# MarkdownViewer 渲染验证
本仓库用于回归模型 README 的 Markdown 渲染能力，每节标注「预期」，便于逐项目检。
覆盖：标题锚点、目录省略、亮/暗色图片、代码块、GFM、公式、提示块、内联 HTML、mermaid、链接改写、边界内容与 ``。
---
## 一、标题 / 锚点 / 去重 / 自定义 id
# 一级标题
## 重复标题
内容 A
## 重复标题
内容 B
### 🚀 快速开始！(v2.0)
#### 自定义锚点 {#custom-anchor}
##### h5
###### h6
预期：每个标题带唯一 id（重复标题自动去重）；emoji 与标点从 id 中剔除；`{#custom-anchor}` 生效；hover 标题显示锚点。
## 二、目录省略（omit in toc）
## 这部分不进大纲
## 模型信息 {#model-info}
## 可见标题
预期：三个标题都正常渲染并保留锚点，仅「可见标题」进入悬浮大纲与标题收集回调。
## 三、亮/暗色图片
预期：`` 按站点主题选择 source（亮色为浅色图标、暗色为 favicon），而不是只看系统偏好；带 `#gh-dark-mode-only` / `#gh-light-mode-only` 的图片在另一主题下隐藏。
## 四、代码块
不指定语言：
```
git status
git add
git commit
```
指定语言可以有更好的展示，python / shell 代码支持引导到 Notebook 运行：
```bash
git status
git add
git commit
```
```python
from modelscope import snapshot_download
model_dir = snapshot_download('Qwen/Qwen3-8B', revision='master')
print(f"downloaded: {model_dir}")
```
```json
{ "framework": "pytorch", "task": "text-generation" }
```
```bibtex
@article{unknown-language, title={未注册语言应降级为纯文本}}
```
行内代码：`pip install modelscope`，以及紧邻标点的 `--device gpu`。
预期：语言高亮正确；未注册语言降级为纯文本；超长命令折行不撑破容器。
## 五、GFM：表格 / 任务列表 / 删除线 / 脚注
| 参数 | 类型 | 默认值 |
| :------- | :----: | -----: |
| `device` | string | cuda |
| `dtype` | string | bf16 |
- [x] 已完成项
- [ ] 未完成项
~~已废弃写法~~ 与正常文本混排。
脚注引用[^1]。
[^1]: 这是脚注内容。
预期：表格有边框与对齐；任务列表出现 checkbox；删除线生效；脚注可跳转。
## 六、数学公式
行内公式 $E = mc^2$ 与 $\alpha_i + \beta_j$。
$$
\mathrm{Attention}(Q,K,V) = \mathrm{softmax}\left(\frac{QK^\top}{\sqrt{d_k}}\right)V
$$
预期：行内与块级公式均由 KaTeX 渲染。
## 七、提示块
> [!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.
预期：五种提示块各有对应色条与标题。
## 八、内联 HTML
点击展开更多细节
被折叠的内容，含 行内代码 与
换行。
H2O 与 x2
预期：居中 div、宽高、details 折叠、sub/sup、table 的 colspan/align 均生效；危险标签与事件属性被剥离。
## 九、mermaid
```mermaid
graph TD
A[用户请求] --> B{命中缓存?}
B -- 是 --> C[返回缓存]
B -- 否 --> D[模型推理] --> E[写缓存] --> C
```
预期：渲染为 SVG；语法错误时降级为原文，不白屏。
## 十、链接与图片
[相对文档链接](./docs/usage.md)
[外部链接](https://modelscope.cn)
预期：相对链接改写为站内文件地址；相对图片改写为文件直链；外链新窗口打开。
## 十一、边界内容
超长单词：ThisIsAVeryLongTokenWithoutAnySpaceThatShouldWrapInsteadOfOverflowingTheContainerAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
| 残缺表格 |
| -------- |
预期：空内容、超长单词、残缺表格都能安全渲染，不报错、不撑破容器。
## 十二、`` 媒体画廊
预期：宿主读取本文件 YAML 头的 `widget` 后传入渲染器，把相对路径的图片改写为仓库文件直链，再渲染为媒体网格（图片 / 视频 + text 图注）；未提供 widget 时不渲染空白容器。