Show markdown reference for the description block

オープン

#87 2021年10月7日に作成コメント 0 件リアクション 0 件担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度: 3/5
見積もり時間: 1〜2日
初心者へのやさしさ: 35/100

issue の種類: 機能追加
明瞭さ: おおむね明確
活発さ: 停滞
技術スタック: markdown, ruby
領域: frontend

調査の方向性

Issue では説明ブロックをエントリーポイントとして特定していますが、ファイルやテストは指定されていません。まずその UI を見つけ、現在その Markdown コンテンツがどのようにレンダリングされているかを確認してください。提案されているホバーリファレンスを、リンク先の GitHub の凡例またはドキュメントと比較してください。ユーザーが説明ワークフローを離れずに、簡潔な基本 Markdown リファレンスへアクセスできれば完了です。

索引モデルが issue の本文から書いたものです。

説明

Feature Request

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

Branch/Commit:

Main branch.

Describe the feature:

As a <role name>
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.

I will abide by the code of conduct

主要言語: Ruby
スター: 42
フォーク: 17
PR マージ指標: 30日以内にマージされた PR はありません

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
リポジトリをフォークし、ブランチを切って変更します。
issue 番号を参照したプルリクエストを送ります。

fastruby/points のほかの issue

Separate rejected stories from approved and pending オープン

Feature Request ux

難易度 3/5 1〜2日初心者へのやさしさ 38/100

fastruby/points#338 · 2025年1月21日に作成
As a user, I want to update the story status from the project show page オープン

Feature Request

難易度 3/5 1〜2日初心者へのやさしさ 45/100

fastruby/points#323 · 2024年1月23日に作成
Order stories by status オープン

Feature Request

難易度 3/5 1〜2日初心者へのやさしさ 35/100

fastruby/points#316 · 2023年10月31日に作成
Add relationship between "template story" and "client instance story" オープン

Feature Request

難易度 5/5 1週間以上初心者へのやさしさ 30/100

fastruby/points#314 · 2023年10月10日に作成
Style for rendered markdown doesn't work outside the description preview オープン

Bug

難易度 3/5 1〜2日初心者へのやさしさ 35/100

fastruby/points#306 · 2023年9月20日に作成

fastruby/points の issue をすべて見る

似ている issue

P4 FR: Add one-click copy-to-clipboard button to code snippets in static workshop HTML オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

palladius/rails8-app-on-gcp#145 · 2026年9月23日に作成
Restore `preview_sensitive_media` to the admin UI オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

mastodon/mastodon#40662 · 2026年9月23日に作成
Cop idea: prefer `be_an_instance_of` over `be_instance_of` オープン

難易度 2/5 1〜3時間初心者へのやさしさ 75/100

rubocop/rubocop-rspec#2236 · 2026年9月23日に作成
condition solver and JSON Schema are out of sync? オープン

bug

難易度 2/5 1〜3時間初心者へのやさしさ 70/100

riscv/riscv-unified-db#2624 · リアクション 1 件 · 2026年9月23日に作成
Bounces#match crashes with NameError for already-bounced recipients オープン

難易度 1/5 1時間未満初心者へのやさしさ 88/100

yegor256/mailanes#322 · 2026年9月22日に作成

Ruby の issue をもっと見る