ml5js/ml5-library

[documentation] Doc using hash router

Open

#647 创建于 2019年10月19日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)JavaScript (905 fork)batch import
documentationgeneralhelp wanted

仓库指标

Star
 (6,136 star)
PR 合并指标
 (30 天内没有已合并 PR)

描述

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.

贡献者指南

研究方向
检查文档站点的路由器配置（可能在应用的入口文件或路由设置中）。找到类似 `history: createHashHistory()` 的行，替换为 `history: createBrowserHistory()`。确保 Web 服务器配置为处理客户端路由（例如，将所有请求重定向到 index.html）。
技术栈
javascript
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85