Skip to content

updating index/navigation and optimizing mkdocs view#565

Merged
Anduin2017 merged 2 commits into
Anduin2017:masterfrom
simingy:master
Mar 1, 2022
Merged

updating index/navigation and optimizing mkdocs view#565
Anduin2017 merged 2 commits into
Anduin2017:masterfrom
simingy:master

Conversation

@simingy

@simingy simingy commented Mar 1, 2022

Copy link
Copy Markdown
Contributor

尝试修这个 bug #559
把README.md的content挪到mkdocs.yaml里了
如果follow这个model的话以后每一个新的PR都要修改这个文件。

由于你的recipe都在root folder,导致必须使用same-dir插件,跟https://oprypin.github.io/mkdocs-literate-nav/#nav-cross-link有点冲突,没法直接使用,只能出此下策

如果refactor一下把markdown都放到docs/文件夹下,就option多了很多

现在的样子
image

修改类型

这个 Pull Request 是在:

  • 增加菜谱
  • 修复错误
  • 其它

检查单

  • 我已阅读贡献模板,并按照模板规范进行了内容创作。
    • 菜谱包含必备原料和工具, 计算, 操作三部分内容。
    • 菜品的原材料用量是无歧义且准确的。对于可以自行发挥的量给出了建议的范围。
    • 菜品的制作步骤是无歧义,准确且完整的。对于每一个步骤的开始和结束都有明确的标准。
  • 我没有破坏模板的一二级标题格式。
  • 我没有删除模板中必需的内容。
  • 我已删除干净所有的复制出来的模板的注释。
  • 我确保我没有签入任何和版权方相关的内容、图片。

请审核人员按照 审核检查单 对照审核检查。

警告

HowToCook 仓库采用了 The Unlicense 协议!

菜谱在签入前,必须确保其可以直接声明进入 "公共领域"(public domain)。这意味着一旦合并后,任何人都可以自由复制,修改,发布,使用,编译,出售或以菜谱的形式或菜的形式分发,无论是出于商业目的还是非商目的,以及任何手段。

@simingy

simingy commented Mar 1, 2022

Copy link
Copy Markdown
Contributor Author

不建议直接merge,你可以看看效果

@Anduin2017

Copy link
Copy Markdown
Owner

我觉得我们可以开发点儿进阶的,用actions自动生成那个yml文件。

@Anduin2017 Anduin2017 merged commit c98598f into Anduin2017:master Mar 1, 2022
@simingy

simingy commented Mar 1, 2022

Copy link
Copy Markdown
Contributor Author

能不能把tips, dishes这两个folder挪入docs/

不放在根目录下

@Anduin2017

Copy link
Copy Markdown
Owner

其实我觉得怎么放都可以。但是现在有一个很严重的问题就是:

我想保留每道菜的贡献历史。如果移动或重命名, Git就无法正确显示文件的blame信息了。

我建议你可以这么操作:

在CI的pipeline完成checkout后,手工用mv命令挪动这两个文件夹。

@simingy

simingy commented Mar 2, 2022

Copy link
Copy Markdown
Contributor Author

git move之后git log --follow是会显示contributor history的
如果因为这不能refactor code structure这广大的开源repo都可以关门了

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants