fastruby / fastruby/points

Show markdown reference for the description block

未关闭
#87 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
Feature Request
主要语言
Ruby
星标
42
派生
17
PR 合并指标
30 天内没有已合并 PR

描述

https://ombulabs.atlassian.net/browse/DT-264

**Branch/Commit:**

Main branch.

**Describe the feature:**

> **As a \**
> **I want to see a quick reference of some markdown syntax**
> **So I don't have to look for that in other places**

I imagine a small `(?)` element next to the description that, on hover, shows a quick cheat-sheet of the basic for formatting and code blocks.

**Problem:**

Currently, if you need some syntax reference, you have to google for it or remember it. Also, for example, 4-space indentation looks better than tripple backtick for code blocks, maybe we can suggest to use the former instead in that cheat-sheet.

**Resources:**

Here in github, we have this legend below the description block, clicking it takes you to a documentation page, we could also do that, linking to this same documtation maybe if we don't want a custom cheat-sheet.

![image](https://user-images.githubusercontent.com/188464/136452385-a8d84526-c09a-4521-af49-92887ae3ec93.png)

**I will abide by the [code of conduct](CODE_OF_CONDUCT.md)**

贡献指南

这个仓库没有索引到贡献指南

调研方向

该 issue 将描述块确定为入口点,但没有指明文件或测试。首先定位该 UI,并检查其 Markdown 内容目前是如何渲染的;将提议的悬停参考与链接的 GitHub 图例或文档进行比较。当用户无需离开描述工作流即可访问简明的基础 Markdown 参考时,即视为完成。

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

评估

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

把新 issue 发到你的邮箱

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