Gitbook README.md

文章目录

Gitbook README.md
- 1. 自述和介绍
- 2. 其他文件替代 README.md

1. 自述和介绍

书本的首页内容默认是从文件 README.md 中提取的。

README.md是 gitbook 最基础的文件之一，它一般用来描述这本书最基本的信息。它呈现给读者这本书最初的样子，如果内容不够简洁明了，很可能就没有看下去的欲望了。

可以通过 gitbook init 自动创建该文件。

如果这个文件名没有出现在 SUMMARY.md (目录索引文件) 中，那么它会被添加为章节的第一个条目。

2. 其他文件替代 README.md

一些项目更愿意将 README.md 文件作为项目的介绍而不是书的介绍。

大部分代码托管平台将 README.md 自动显示到项目首页，如果你不喜欢这样。从GitBook >2.0.0 起，就可以在 book.json 中定义某个文件作为README。

book.json
{"structure" : {"readme" : "information.md"}
}

gitbook README.md相关推荐

TVM示例展示 README.md，Makefile，CMakeLists.txt
TVM示例展示 README.md,Makefile,CMakeLists.txt TVM/README.md Open Deep Learning Compiler Stack Documentat ...
github README.md教程
github README.md教程总结 github中README.md通过特殊字符标记和缩进来达到格式控制,也可以用HTML标签来实现格式控制. 教程一: Markdown 的目标是实现「易读易 ...
GitHub上README.md教程
http://blog.csdn.net/kaitiren/article/details/38513715 最近对它的README.md文件颇为感兴趣.便写下这贴,帮助更多的还不会编写README文 ...
Python语言学习之打印输出那些事：python输出图表和各种吊炸天的字符串或图画、版权声明(如README.md)等之详细攻略
Python语言学习之打印输出那些事:python输出图表和各种吊炸天的字符串或图画.版权声明(如README.md)等之详细攻略目录打印输出标准文档 1.输出表格 2.打印输出各种吊炸天的字符串 ...
GitHub上README.md教程(copy)
[说明:转载于http://blog.csdn.net/kaitiren/article/details/38513715] 最近对它的README.md文件颇为感兴趣.便写下这贴,帮助更多的还不会编 ...
springboot 建readme_经验分享：给项目创建和编写README.md文件的步骤
在项目开发过程中,不仅要注意代码的编写质量,也要为合作开发打好基础,尤其是合作开发的时候,同事直接的代码需要熟悉,这就需要在开发的时候进行注释操作,方便别人维护和熟悉代码.除了上述两个重要的点之外,还 ...
【转】GitHub上README.md教程
本文是转载文章,文章的来源:csdn博客博主:果冻虾仁文章: GitHub上README写法暨GFM语法解读博文地址:https://blog.csdn.net/guodongxiaren/ar ...
【Github】怎么在README.md中添加图片？
原理是将图片作为文档上传,在README.md中引用即可. 参考博客:[GitHub]给GitHub上的ReadMe.md文件中添加图片怎么做 . gitHub创建文件夹
Hexo 博客添加 README.md 以及部署到 GitHub 丢失/显示不正常解决方法
GitHub 项目的README.md为自述文件,可对该项目进行介绍,解释等. 使用 Github Pages 和 Hexo 搭建的博客,如果在最开始建立仓库的时候没有创建README.md文件,那么 ...

gitbook README.md

Gitbook README.md

文章目录

1. 自述和介绍

2. 其他文件替代 README.md

gitbook README.md相关推荐

最新文章

热门文章