ml5js/ml5-library

[documentation] Doc using hash router

Open

#647 建立於 2019年10月19日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)JavaScript (6,136 star) (905 fork)batch import
documentationgeneralhelp wanted

描述

It seems that the doc website is using a router in hash mode. For example, URL of the index of the reference section is https://learn.ml5js.org/docs/#/reference/index. There is a hash tag "#" in the URL.

This may make it a little obfuscating for people who want to memorize the link and share it with others.

I recommend changing the router from hash mode to history mode to remove the ugly hash tag.

貢獻者指南

技術棧
javascripthtmlcss
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Basic web developmentUnderstanding of URL routing
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
50
研究方向
Examine the documentation website's source code in the repository (likely under docs/ or website/). Identify the static site generator in use (e.g., VuePress, Docusaurus) and find the configuration file where router mode is set. Change from hash to history mode, update any references to URLs without the hash, and verify all internal links still function. Check the issue comments for any additional context or constraints.