:dfn[foo] should be presented in a way that allows for linking to them

オープン
#7 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
javascript

調査の方向性

:dfn 定義とそのアンカーがどのようにレンダリングされるかを確認することから始め、次にその動作を既存の header-link の表示およびリンク先の例と比較してください。読者が定義を認識し、現在の spec のレイアウトを崩さずにそのアンカーリンクをコピーまたは利用できれば完了です。

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

説明

Currently, it is not possible to copy link to specific definition, even tho each have own anchor, and we link to them:

(example from https://github.com/ipfs/specs/pull/390)
2023-03-31_18-39

Quick ideas:

  • style :dfn[ so we can spot them? (dotted underline? Italic font? different weight?)
  • on :hover show <a> as # on the left (similar to how we already expose links to headers, but hide them by default)

cc @darobin @hacdias thoughts / ideas / examples how we could present this better?

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

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

ipfs/spec-generator のほかの issue

ipfs/spec-generator の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。