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

前言

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

开始

在你的仓库的主分支里创建一个 /docs/index.md 文件。
index.md文件添加内容，并提交你的修改。
查看你的仓库的设置分支然后选择主分支 /docs 目录，将其设置为 GitHub Pages 的源，点击保存，你就搞定了
GitHub Pages 将会从你的 /docs 目录中读取内容，转换 index.md 为 HTML。然后把它发布到你的 GitHub Pages 的 URL 上。
选择一个主题
访问项目地址：http://github.tinywan.com/lua-nginx-redis/
最后搭建成功后的效果图

Git与GitHub学习笔记（六）使用 Github Pages 管理项目文档相关推荐

MFC 学习笔记（一）：MFC单文档程序运行流程梳理与总结
MFC 学习笔记(一):MFC单文档程序运行流程梳理与总结 1.MFC单文档程序运行流程 1.首先利用全局变量对象 theApp 启动应用程序 (这是因为这个全局对象,基类CWinApp中 this ...
Java学习笔记整理-知识梳理+JDK1.8详细文档
链接:java开发手册提取码:kes8 链接:JDK1.8详细文档提取码:n9zo JavaSE 面向对象编程(Object-oriented programming) 封装类(class) 类 ...
OpenCascade学习笔记-创建一个简单的OpenCascade单文档
分享一下我老师大神的人工智能教程!零基础,通俗易懂!http://blog.csdn.net/jiangjunshow 也欢迎大家转载本篇文章.分享知识,造福人民,实现我们中华民族伟大复兴! Open ...
Redis个人学习笔记参考B站视频以及CSDN文档 2万多字非常全面
参考内容: B站尚硅谷Redis视频教程 <Redis 6 入门到精通超详细教程> B张黑马程序员Redis视频教程 <黑马程序员Redis入门到实战教程,全面透析redis底层 ...
【转载】Redis个人学习笔记参考B站视频以及CSDN文档 2万多字非常全面
参考内容: B站尚硅谷Redis视频教程 <Redis 6 入门到精通超详细教程> B张黑马程序员Redis视频教程 <黑马程序员Redis入门到实战教程,全面透析redis底层 ...
《Webservice的应用与开发》学习笔记 ·001【Web服务、XML文档】
注:前言.目录见 https://blog.csdn.net/qq_44220418/article/details/108428971 文章目录一.Web服务 1.特点 2.定义二.XML文档 ...
Python学习笔记(29)-Python创建并写入word文档
点此查看零基础Python全栈文章目录及源码下载本文目录 1. 简介 2. 代码演示 1. 简介上一篇已经介绍了python-docx模块的安装和导入,本篇直接介绍如何创建并写入word文档,需 ...
Git 学习笔记：6 GitHub
Git 学习笔记:6 GitHub 账户的创建和配置 SSH访问头像邮件地址两步验证对项目做贡献派生(fork)项目 GitHub 流程创建合并请求利用合并请求合并请求的进阶用法将 ...
git/github学习笔记
原文地址为: git/github学习笔记请移步到:http://www.testclass.net/git/ ----- 我重新对git/github教程进行了编排和整理. 1. git 版本控制 ...

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

前言

开始

Git与GitHub学习笔记（六）使用 Github Pages 管理项目文档相关推荐

最新文章

热门文章