文章来源于网络收集而来,版权归原创者所有,如有侵权请及时联系!
README.md 文件
必要的 README.md 文件
README.md
是 gitbook 最基础的文件之一,它一般用来描述这本书最基本的信息。 它呈现给读者这本书最初的样子,如果内容不够简洁明了,很可能就没有看下去的欲望了。
可以通过 gitbook init
自动创建该文件。
使用其他文件替代README.md
一些项目更愿意将 README.md
文件作为项目的介绍而不是书的介绍。 大部分代码托管平台将 README.md
自动显示到项目首页,如果你不喜欢这样。 从GitBook >2.0.0 起,就可以在 book.json
中定义某个文件作为README。
book.json
{
"structure" : {
"readme" : "information.md"
}
}
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论