GitBook 使用说明

申请使用

  • 第一步:在企微里申请使用权限,并提交你的github账户

  • 第二步:通过后,你将收到一封邮件,点击邀请获得git链接

目录结构

 .
 ├── SUMAMRY.md      --左侧菜单
 ├── README.md       --默认文件,每个目录必须保留,不然路由不能正常识别
 ├── wiki/           --文档目录
 └──      archives/  --文章栏目:新知识、经验等文章
 └──      doc/       --知识库栏目:规范类、公司内部、复盘、新人必读类的文章
 └──      activity/  --技术沙龙:openTalk
 └──      about/     --关于我们

写文章

  • 在对应目录下编写你的MD文章

  • 更新SUMAMRY.md,链接你的文章

  • git上传(只上传md文件,不传编译文件,服务器会自动构建)

图片上传

图片不要引用网上的,因为外链图片会挂的,所以另存图片并上传到github去。

建议使用uPic上传图片,非常方便好用。 https://github.com/gee1k/uPic

注意事项

关于二级页面链接

二级页面的链接必须包含在SUMMARY.md里,且必须在对应栏目下,不然不能正确生成。

更多信息

请自行查看gitbook文档 http://gitbook.hushuang.me/structure.html

最后更新于