开发者社区> Tinywan.> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

Git与GitHub学习笔记(六)使用 Github Pages 管理项目文档

简介: 前言 你可能比较熟悉如何用 Github Pages 来分享你的工作,又或许你看过一堂教你建立你的第一个 Github Pages 网站的教程。近期 Github Pages 的改进使得从不同的数据源来发布您的网站更加的方便,其中的来源之一就是你的仓库的 /docs 目录。
+关注继续查看

前言

你可能比较熟悉如何用 Github Pages 来分享你的工作,又或许你看过一堂教你建立你的第一个 Github Pages 网站的教程。近期 Github Pages 的改进使得从不同的数据源来发布您的网站更加的方便,其中的来源之一就是你的仓库的 /docs 目录。
文档的质量是一个软件项目健康发展的标志。对于开源项目来说,维护一个可靠而不出错的知识库、详细说明所有的细节是至关重要的。精心策划的文档可以让增加项目的亲切感,提供一步步的指导并促进各种方式的合作可以推动开源软件开发的协作进程。

开始

  • 在你的仓库的主分支里创建一个 /docs/index.md 文件。

    img_922a644d89e08796e8e55a98bc3b7320.png

  • index.md文件添加内容,并提交你的修改。

    img_ba2b1eaf8390f313b55fda6e7d62ab54.png

  • 查看你的仓库的设置分支然后选择主分支 /docs 目录,将其设置为 GitHub Pages 的源 ,点击保存,你就搞定了
  • GitHub Pages 将会从你的 /docs 目录中读取内容,转换 index.md 为 HTML。然后把它发布到你的 GitHub Pages 的 URL 上。
  • 选择一个主题

    img_a1229edc8c81371d4f16ab16dd415eb7.png

  • 访问项目地址:http://github.tinywan.com/lua-nginx-redis/
  • 最后搭建成功后的效果图
    img_ea014c657a1a8c791f6a281dac273383.png

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
Github项目搜索技巧! 教你高效地在GitHub上寻找开源项目
本篇文章是一篇Github项目搜索技巧介绍的文章。主要帮助大家如何熟练使用Github的搜索来找到自己想要的项目。介绍了项目名称搜索,项目详情搜索以及项目描述搜索几种方式。最后介绍了如何寻找到一个高质量的,值得学习的项目。通过这篇文章的指导,可以让你高效地寻找到优秀的开源项目来提升自己的项目经验。
164 0
如何从github下载并运行angular项目
以angular4.0为基础,写了个企业级快速开发的开源项目,放在了github上,很多人竟然私聊问我怎么用…… 写个手册吧。 首先贴我的项目地址: 开源中国(码云)地址:https://gitee.
2475 0
GitHub 版本控制 项目托管 05 创建GitHub本地仓库1-创建空仓库
(本博客GitHub分支下所有相关资料的统一下载链接:http://pan.baidu.com/s/1bo5RrtX) (PS:任何问题欢迎在下方评论区留言,12小时内回复~) 上接《GitHub 版本控制 项目托管 04 创建GitHub远程仓库》。
933 0
GitHub 版本控制 项目托管 06 创建GitHub本地仓库2-加入代码工程
(本博客GitHub分支下所有相关资料的统一下载链接:http://pan.baidu.com/s/1bo5RrtX) (PS:任何问题欢迎在下方评论区留言,12小时内回复~) 上接《GitHub 版本控制 项目托管 05 创建GitHub本地仓库1-创建空仓库》。
971 0
如何把项目托管到GitHub
一.进入GitBash   红圈部分是clone的仓库所在地址,从左面左上角的Administrator或者C:\Users\Administrator.PC-201505250855都可以进入。
1258 0
文件管理命令 | 学习笔记
快速学习文件管理命令。
58 0
+关注
文章
问答
文章排行榜
最热
最新
相关电子书
更多
AGit-Flow:新一代高效Git协同模型
立即下载
AGit-flow:新一代高效Git协同模型
立即下载
新一代高效Git协同模型
立即下载