本文预计阅读时间:3分钟
当我们在Github上看见一个不错的开源项目,想把玩一下,但是,项目的说明文档往往写得比较粗糙,尤其是复杂的开源项目更甚。
现在好了,借着AI的优势,拆解Github文档不再困难,来看看如何使用DeepWiki和ReadMex拆解Github文档。
DeepWiki
访问官网https://deepwiki.com/ :
这里收藏了很多Github开源项目的文档,据说有5K+。
在搜索框里面,根据关键字搜索开源项目文档,以Ollama为例:
此时,有关Ollama的开源项目都显示出来了,打开第一个:
目测顺序是按star数进行标记的。
来到Ollama的项目文档:
现在问一下如何安装Ollama:
DeepWiki很快将检索内容整理并显示:
看不懂英文?
如果看不懂英文也没用关系,可以通过浏览器插件翻译一下,然后再中文提问:
然后等它整理答案:
如果懒得用浏览器插件翻译,也可以直接用中文提问,它也会用中文回答问题。
花式玩法!
你以为骚操作就这样?之前的只是基操而已!
打开Ollama的Github仓库地址
https://github.com/ollama/ollama
看着都还是正经的Github显示
小改动一下地址,将github替换
将 https://github.com/ollama/ollama
替换为 https://deepwiki.com/ollama/ollama
然后,回车:
就说牛不牛!
项目不在DeepWiki中?
如果通过DeepWiki访问方式,发现感兴趣的项目不在其中,可以有2种方式解决。
方式1:将项目添加到官网
通过仓库名称或仓库地址进行添加:
方式二:访问项目地址链接时,替换github,参考花式玩法
ReadMeX
readmex与DeepWiki的使用差不多,就不细说了,使用方式参考DeepWiki就行。
readmex的官方地址是https://readmex.com/,与readmex不同,readmex生来就是中文显示的,可以简单把它看作是DeepWiki的汉化版。
但是,readmex收录的内容似乎没有DeepWiki那么全,比如这个mcp-prompt-server开源项目,在DeepWiki中有,而readmex没有收录。
此外,readmex添加仓库似乎也有点问题:
总结
从个人使用来讲,当前还是建议使用DeepWiki,它的丝滑程度好过readmex。
#DeepWiki
#readmex