VitePress visual improvements

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

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

評価

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

調査の方向性

VitePress のテーマスタイルと影響を受けるドキュメントページを確認し、まずコードブロック、ライトテーマ、ホームページ、埋め込み、見出しアンカーを対象にします。ライトテーマとダークテーマでレンダリングされたドキュメントを比較し、一覧に挙げられた視覚的な改善に対処したうえで、ページの可読性と一貫性が保たれていることを確認します。

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

説明

Some visual improvements to be made after the switch to VitePress:

  • Better separation of codeblock titlebar and codeblock
    • This can either be a small border or a different bf color
  • Improve light theme compatibility
    • Fix sidebar logo
    • Fix syntax highlighting
    • Fix homepage gradient
    • Potentially adjust color scheme slightly
  • Potentially switch to GitHub style admonitions
    • This will allow easier reading of the docs on github for those that choose to do so
  • Consider using a custom tab component in places where a codeblock and details block are used together
  • Potentially add in page navigation breadcrumbs
  • Make youtube embeds scale more rationally
  • Make heading anchors permanently visible and to the right
主要言語
CSS
スター
37
フォーク
71
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

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

BetterDiscord/docs のほかの issue

BetterDiscord/docs の issue をすべて見る

似ている issue

Design の issue をもっと見る

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

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