docsifyjs / docsifyjs/docsify

I hope the screen reader software doesn't read 'link' when it reads the title

未关闭
#1,222 4 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
accessibility enhancement wait for information
主要语言
JavaScript
星标
31.5k
派生
5.8k
平均合并
9 天 8 小时
30 天内合并 PR
2

描述

## Feature request

I hope to add a feature that the md file title does not read out the link.

#### What problem does this feature solve?

Friendly for some people who use screen reader software

#### What does the proposed API look like?

just like

```
window.$docsify = {
readLink: false,
}
```

#### How should this be implemented in your opinion?

I don't think this should be hard to implement, e.g. generating html for md files without a tag.

#### Are you willing to work on this yourself?

I'm afraid I can't.

贡献指南

打开贡献指南

调研方向

Issue 中没有提到文件或测试。首先跟踪 Markdown 标题如何变成 HTML,以及如何读取 window.$docsify 选项;当已配置的标题行为不再导致屏幕阅读器将其读作链接,同时保留现有的标题导航时,即表示完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript
领域
accessibility, documentation
Issue 类型
功能
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
38/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。