Cross reference links can lead to 404 pages
还没有人认领这个 Issue。
评估
- 难度
- 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
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
GDQuest/gdscript-docs-maker 的其他 Issue
-
KeyError: 'name' while generating markdown files可能重新可做 关联的 PR 已关闭且未合并。 未关闭
难度 3/5 1-2 天 新手友好度 38/100
GDQuest/gdscript-docs-maker#95 · 4 条评论 · 1 个 reaction ·
-
难度 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 个 reaction ·
-
bug
难度 3/5 1-2 天 新手友好度 35/100
GDQuest/gdscript-docs-maker#71 · 3 条评论 ·
查看 GDQuest/gdscript-docs-maker 的全部 Issue
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 78/100
uniswap-python/uniswap-python#487 ·
-
[Bug]: agent_final_response still returns the abandoned branch's answer after navigate moves HEAD back可能已有人在做 @enyst 今天认领。 未关闭bug priority:low ready-for-dev
难度 2/5 1-3 小时 新手友好度 72/100
OpenHands/software-agent-sdk#5822 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 72/100
-
area: server enhancement good first issue
难度 2/5 1-3 小时 新手友好度 82/100
scs0209/laya-guard#52 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 2 天内回复