Anduin2017 / Anduin2017/HowToCook
目录混乱 + 中文目录
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 102k
- Forks
- 11.1k
- Avg merge
- 14h 21m
- Merged PRs (30d)
- 2
Description
mkdocs scan folder生成的HTML index基本上是乱的
可以利用https://www.mkdocs.org/user-guide/writing-your-docs/
来customize navigation bar
比方说：
nav:
- README.md
- 菜谱: dishes/
- 做菜技巧: tips/
- CONTRIBUTING.md
Idea：
- Contributions放在最下面
- 中文目录 （dishes -> 菜谱）
但是现在mkdocs nav section并不支持folder https://github.com/mkdocs/mkdocs/issues/714
可以写个脚本每次自动生成nav:这个section，或者直接把文件夹名字改成中文
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the MkDocs writing-your-docs guide and inspect the current navigation configuration alongside the dishes/ and tips/ folders. Compare the available approaches for ordering contributions last and presenting Chinese labels; done means the generated HTML index has the intended navigation without disrupting the existing documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, yaml
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100