GitHub 项目如何避免 README 和文档的内容重复？
kxxoling · kxxoling · 2015-05-02 14:55:03 +08:00 · 2272 次点击这是一个创建于 3500 天前的主题，其中的信息可能已经有所发展或是发生改变。
打算把项目的 README 整理成结构更清晰的文档，想当然的使用了 rst 的 include，结果 GitHub 不认这种写法： https://github.com/kxxoling/PrettyTable/tree/develop
GitHub Markup 项目中也讨论了好久，但是一直没有后续消息，有什么比较干净的 workaround 推荐吗？
 |
1
SoloCompany 2015-05-02 15:48:04 +08:00
不要直接放到 Readme 里面，然后通过 generate 出来的静态网站展示不就能解决问题了？
|
 |
2
kxxoling OP @SoloCompany 没明白。。现在的想法是在文档里 include 外面目录的 README，但是个人不喜欢这种 include，容易引起循环引用的问题。
|
 |
3
kcworms 2015-05-03 11:04:23 +08:00
和#1一样的想法，考虑一下用github pages？把文档扔到里面再在readme里加个指向站点的链接。
或者扔到github wiki里 |
|
5
kcworms 2015-05-03 15:46:03 +08:00
@kxxoling 你的意思是一定要把文档和代码放在一个repo甚至同branch里，而且还按内容拆成小文件，最后README必须合并显示这些小文件且不能复制粘贴吗
|
 |
7
timpaik 2021-08-25 00:25:56 +08:00 via Android
试试 README.rst 直接放到 docs 文件夹？
|
Select Language