Cross reference links can lead to 404 pages
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- バグ
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- html, hugo, markdown, python
調査の方向性
ソースファイルもテストも指定されていません。Markdown、HTML、Hugo 出力の相互参照リンク生成のエントリポイントを特定し、ここで説明されている想定パスを Sphinx および Godot のドキュメントの動作と比較してください。生成されたリンクがデスクトップ Markdown、直接 HTML、Hugo サイトで機能すれば完了です。
索引モデルが issue の本文から書いたものです。
説明
The latest version of the program supports cross-references like [ClassName.method], etc. but the links don't always work. Part of the problem cannot be fixed without input from the user.
The problem
When previewing markdown documents on your desktop, the links should point to markdown files to work, as you're browsing through your file system. E.g. ClassName.md
If you convert to html and/or put the files on the web, the links should point to the page's name or file, ./ClassName or ./ClassName.html or the lowercase equivalents.
Hugo may change the case of the links depending on the website's settings I believe?
Solution
For markdown, I'm currently linking to ../PageName. This should work if you put your pages online with a CMS, but it won't if you output your files as html directly. To solve this, we might need to have an html output that writes links as ../pagename.html#header-name. We can look at how Sphinx and the Godot docs handle that.
In the hugo format, links should probably use the {{< relref >}} shortcode. This shortcode takes a relative path to a markdown document and resolves the final path for you. We have the exact name of the markdown documents so this would work reliably.
- 主要言語
- Python
- スター
- 297
- フォーク
- 26
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
GDQuest/gdscript-docs-maker のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 38/100
GDQuest/gdscript-docs-maker#95 · コメント 4 件 · リアクション 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
-
enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 55/100
GDQuest/gdscript-docs-maker#86 · リアクション 1 件 ·
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
GDQuest/gdscript-docs-maker#71 · コメント 3 件 ·
GDQuest/gdscript-docs-maker の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
browser-use/browser-use#5905 ·
-
type: enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
ynput/ayon-python-api#363 ·
-
bug needs triage
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
modelscope/FunASR#3728 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
open-compass/opencompass#2655 ·