plotly / plotly/plotly.js

[mkdocs] - rebuild docs automatically on update

未关闭
#7,644 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
JavaScript
星标
18.3k
派生
2k
平均合并
2 天 12 小时
30 天内合并 PR
28

描述

One of the benefits of our current docs for contributors if you are working on a doc and make some change to an example or some text, jekyll rebuilds the documentation automatically and you can see the change in your browser.

With how mkdocs is implemented on the live-docs branch you need to stop the mkdocs server, rebuild the docs using make examples and then restart the server (mkdocs serve)

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 live-docs 分支开始,检查当前如何使用 make examplesmkdocs serve。跟踪文档重新构建流程,并将其与所描述的 Jekyll 行为进行比较;完成的标准是,示例或文本的更改会在浏览器中显示,而无需手动停止、重新构建和重新启动服务器。

由索引模型根据 Issue 内容生成。

评估

领域
build-system, documentation
Issue 类型
功能
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。