使用Gitee + Read the Docs搭建文档¶

使用说明¶

一、文档撰写前提¶

Note

环境部署:

> git clone https://gitee.com/zhyantao/readthedocs.git
> pip install sphinx recommonmark sphinx-autobuild sphinx_rtd_theme -i http://mirrors.aliyun.com/pypi/simple/ --trusted-host=mirrors.aliyun.com

二、撰写博文并发表¶

把需要发表的文档放在 source/docs 文件夹中（写作格式可以是markdown或者reStructuredText）
CMD中输入 make html 回车，打开 build/html/index.html 预览效果
提交代码（博文）到 Gitee 仓库 [git简易指南]
在 Read the Docs中导入 Gitee 项目
导入成功后，点击 View the documentation 查看最终效果 [示例]

Warning

除了 demo-readthedocs/source/docs 下的文件和 source/index.rst 可以修改外，其他位置的文件不要修改，否则可能会引起错误。另外，务必在 source/index.rst 文件中添加你的博文的路径

测试页面一¶

页面简介

Git常用命令¶

仓库¶

# 在当前目录新建一个Git代码库
$ git init

# 新建一个目录，将其初始化为Git代码库
$ git init [project-name]

# 下载一个项目和它的整个代码历史
$ git clone [url]

配置¶

# 显示当前的Git配置
$ git config --list

# 编辑Git配置文件
$ git config -e [--global]

# 设置提交代码时的用户信息
$ git config [--global] user.name "[name]"
$ git config [--global] user.email "[email address]"

增加/删除文件¶

# 添加指定文件到暂存区
$ git add [file1] [file2] ...

# 添加指定目录到暂存区，包括子目录
$ git add [dir]

# 添加当前目录的所有文件到暂存区
$ git add .

# 添加每个变化前，都会要求确认
# 对于同一个文件的多处变化，可以实现分次提交
$ git add -p

# 删除工作区文件，并且将这次删除放入暂存区
$ git rm [file1] [file2] ...

# 停止追踪指定文件，但该文件会保留在工作区
$ git rm --cached [file]

# 改名文件，并且将这个改名放入暂存区
$ git mv [file-original] [file-renamed]

代码提交¶

# 提交暂存区到仓库区
$ git commit -m [message]

# 提交暂存区的指定文件到仓库区
$ git commit [file1] [file2] ... -m [message]

# 提交工作区自上次commit之后的变化，直接到仓库区
$ git commit -a

# 提交时显示所有diff信息
$ git commit -v

# 使用一次新的commit，替代上一次提交
# 如果代码没有任何新变化，则用来改写上一次commit的提交信息
$ git commit --amend -m [message]

# 重做上一次commit，并包括指定文件的新变化
$ git commit --amend [file1] [file2] ...

分支¶

# 列出所有本地分支
$ git branch

# 列出所有远程分支
$ git branch -r

# 列出所有本地分支和远程分支
$ git branch -a

# 新建一个分支，但依然停留在当前分支
$ git branch [branch-name]

# 新建一个分支，并切换到该分支
$ git checkout -b [branch]

# 新建一个分支，指向指定commit
$ git branch [branch] [commit]

# 新建一个分支，与指定的远程分支建立追踪关系
$ git branch --track [branch] [remote-branch]

# 切换到指定分支，并更新工作区
$ git checkout [branch-name]

# 切换到上一个分支
$ git checkout -

# 建立追踪关系，在现有分支与指定的远程分支之间
$ git branch --set-upstream [branch] [remote-branch]

# 合并指定分支到当前分支
$ git merge [branch]

# 选择一个commit，合并进当前分支
$ git cherry-pick [commit]

# 删除分支
$ git branch -d [branch-name]

# 删除远程分支
$ git push origin --delete [branch-name]
$ git branch -dr [remote/branch]

标签¶

# 列出所有tag
$ git tag

# 新建一个tag在当前commit
$ git tag [tag]

# 新建一个tag在指定commit
$ git tag [tag] [commit]

# 删除本地tag
$ git tag -d [tag]

# 删除远程tag
$ git push origin :refs/tags/[tagName]

# 查看tag信息
$ git show [tag]

# 提交指定tag
$ git push [remote] [tag]

# 提交所有tag
$ git push [remote] --tags

# 新建一个分支，指向某个tag
$ git checkout -b [branch] [tag]

查看信息¶

# 显示有变更的文件
$ git status

# 显示当前分支的版本历史
$ git log

# 显示commit历史，以及每次commit发生变更的文件
$ git log --stat

# 搜索提交历史，根据关键词
$ git log -S [keyword]

# 显示某个commit之后的所有变动，每个commit占据一行
$ git log [tag] HEAD --pretty=format:%s

# 显示某个commit之后的所有变动，其"提交说明"必须符合搜索条件
$ git log [tag] HEAD --grep feature

# 显示某个文件的版本历史，包括文件改名
$ git log --follow [file]
$ git whatchanged [file]

# 显示指定文件相关的每一次diff
$ git log -p [file]

# 显示过去5次提交
$ git log -5 --pretty --oneline

# 显示所有提交过的用户，按提交次数排序
$ git shortlog -sn

# 显示指定文件是什么人在什么时间修改过
$ git blame [file]

# 显示暂存区和工作区的差异
$ git diff

# 显示暂存区和上一个commit的差异
$ git diff --cached [file]

# 显示工作区与当前分支最新commit之间的差异
$ git diff HEAD

# 显示两次提交之间的差异
$ git diff [first-branch]...[second-branch]

# 显示今天你写了多少行代码
$ git diff --shortstat "@{0 day ago}"

# 显示某次提交的元数据和内容变化
$ git show [commit]

# 显示某次提交发生变化的文件
$ git show --name-only [commit]

# 显示某次提交时，某个文件的内容
$ git show [commit]:[filename]

# 显示当前分支的最近几次提交
$ git reflog

远程同步¶

# 下载远程仓库的所有变动
$ git fetch [remote]

# 显示所有远程仓库
$ git remote -v

# 显示某个远程仓库的信息
$ git remote show [remote]

# 增加一个新的远程仓库，并命名
$ git remote add [shortname] [url]

# 取回远程仓库的变化，并与本地分支合并
$ git pull [remote] [branch]

# 上传本地指定分支到远程仓库
$ git push [remote] [branch]

# 强行推送当前分支到远程仓库，即使有冲突
$ git push [remote] --force

# 推送所有分支到远程仓库
$ git push [remote] --all

撤销¶

# 恢复暂存区的指定文件到工作区
$ git checkout [file]

# 恢复某个commit的指定文件到暂存区和工作区
$ git checkout [commit] [file]

# 恢复暂存区的所有文件到工作区
$ git checkout .

# 重置暂存区的指定文件，与上一次commit保持一致，但工作区不变
$ git reset [file]

# 重置暂存区与工作区，与上一次commit保持一致
$ git reset --hard

# 重置当前分支的指针为指定commit，同时重置暂存区，但工作区不变
$ git reset [commit]

# 重置当前分支的HEAD为指定commit，同时重置暂存区和工作区，与指定commit一致
$ git reset --hard [commit]

# 重置当前HEAD为指定commit，但保持暂存区和工作区不变
$ git reset --keep [commit]

# 新建一个commit，用来撤销指定commit
# 后者的所有变化都将被前者抵消，并且应用到当前分支
$ git revert [commit]

暂时将未提交的变化移除，稍后再移入
$ git stash
$ git stash pop

其他¶

# 生成一个可供发布的压缩包
$ git archive

使用Markdown快速书写¶

快速入门¶

特殊符号书写¶

notepad++完美配置markdown¶

安装markdown支持
MarkdownViewer++: Markdown实时预览，可以使用NPP中的PluginManager安装

音频测试¶

源代码¶

<video  width="100%" height="100%" src="//gslb.miaopai.com/stream/PAEyMDoxMSB9hV6BVT1l5SHT-sMVVRVgHlL7bA__.mp4?mpflag=64&amp;vend=1&amp;os=3&amp;partner=1&amp;platform=2&amp;cookie_id=&amp;refer=miaopai&amp;scid=PAEyMDoxMSB9hV6BVT1l5SHT-sMVVRVgHlL7bA__ " controls="controls">
您的浏览器不支持 video 标签。
</video>

试错记录¶

根据阿甘的博客来进行尝试，发现：
- 如果不渲染.md文件，根本不会产生html文件。
- 如果不渲染.html文件，首先需要先将.md文件渲染后的文件复制到和.md文件同级目录，否则html文件将不会被加载到public子目录中。
根据zhouie的操作说明，发现：
- 插入iframe标签，不管用
- 插入video标签，还是不管用
尝试了几个未能成功，那就自己从源代码上找原因了，发现hexo会将<>自动渲染，导致无法显示正常的浏览器无法解析html代码。
了解原因后，就来到了HEXO官网标签插件，阅读说明后，发现了可以使用Raw标签防止html代码被渲染，于是问题得到了解决，下面是展示结果。
需要注意的是引用视频链接要和网站的协议一致，否则会造成无法播放。例如，网站使用的是https，而视频链接地址是http开头的，那就不能播放，浏览器会报错（错误信息见本页底部）。要解决上面的问题可以将链接前面的http:去掉，代码和src="//demo.domain.com/类似

网站报错信息（上接步骤5）¶

Mixed Content: The page at 'https://toooney.cn/2019/01/11/digest/from-college/' was loaded over HTTPS, but requested an insecure resource 'http://open.iqiyi.com/developer/player_js/coopPlayerIndex.html?vid=6c056f77e5235947f18b0475a25a5752&tvId=6025471109&accessToken=2.f22860a2479ad60d8da7697274de9346&appKey=3955c3425820435e86d0f4cdfe56f5e7&appId=1368&height=100%&width=100%'. This request has been blocked; the content must be served over HTTPS.

测试页面二¶

页面简介

实用工具¶

开发者工具箱¶

文档编辑¶

在线文本比较工具
免费在线文件转换器 - 免费在线转换视频，在线图形转换，在线文档转换和在线压缩格式转换
免费解决所有PDF问题 - PDF24 Tools

图片编辑¶

图片压缩，在线图片压缩 - GIF压缩，PNG压缩，JPG，JPEG压缩，最大支持30M [Others]
看图网 - 在线PS，照片编辑，闪图制作，在线美图，在线拼图，GIF制作
图片放大不失真 - High Quality Image Upscaling Freeware

生活和工作工具箱¶

工作学习工具箱¶

风云PPT模板网（156****5317）
ProcessOn - 免费在线作图，实时协作
draw.io - 绘制流程图
国产立创EDA - 一个用心为中国人定制的电路板开发平台
Windows上那些值得推荐的良心软件 - 整理

下载工具¶

PanDownload（电脑端）(提示：最多同时下载三个，否则帐号被限速)
Proxyee-Down - 让下载速度得到解放

找高清图片¶

网站数量较多，如果贴图，会显得文章很长，估计会很少有人有耐心看完，所以本文主要以文字为主，各取所需吧。

摄影素材¶

Unsplash 主要是摄影作品为主
Pexels 海量共享图片素材
FancyCrave 免费摄影图片资源库
Life of Pix 无版权欧美生活图片

商用或者开发者使用¶

Pixabay 第三方用户和网站开发人员可以通过接口搜索其图像数据库
kaboompics 适用于博主、网站主、自由职业者、网页设计师
Magdeleine 高清灵感系图片
pngimg PNG透明背景图库，抠图可用
DesignerPics 网站,简报,宣传册/包装/标签,HTML / PSD模板,T恤衫,广告牌、横…
ISO REPUBLIC 在商業設計或是網頁設計時使用
RAUMROT 可供商用的图片

有定位的网站¶

IM FREE 人物、自然、艺术、生活、图标等
GRATISOGRAPHY 動物、大自然、物件、人物、城市以及難以分類的类型
Visual Hunt 根据颜色进行搜索图片
Flickr 提供免费及付费数位照片储存、分享方案之线上服务。需要翻墙
Pixite Source 可以搜索图片、材质、色调，有很多比较精致的小众插图
無料写真素材红叶、樱花、海洋生物、动物等等的写真素材
StockSnap 生活类图片，角度和主题都不错
New Old Stock 经典、复古、古董的照片
FoodiesFeed 美食图片
PEEKSPACE 太空图片
skuawk 野生动物、景观、城市,人物、技术、…

其他¶

StreetWill 干净整洁无任何广告
Public Domain Archive 用于公共领域的图片
POCO.cn 国内图片网站
SocWall 壁纸较多
500px 排名前500筛选图片
FREEMAGEBANK 图片色调厚实,适合做背景图

均系个人精心整理，如果有帮助请点个赞，作为我继续创作的动力，^_^ 。

测试页面三¶

页面简介

网站建设¶

静态网页¶

动态网页¶

PHP 手册
MySQL Documentation
Laravel: The PHP Framework For Web Artisans
Apache HTTP Server Version 2.2 文档
Catfish(鲶鱼) CMS: 开源免费的PHP内容管理系统

网页设计¶

特殊符号¶

UML绘制：以流程图形式呈现

辅助工具¶

HandyEditor: 一款十分轻便且使用方便的所见即所得web富文本编辑器，由Catfish(鲶鱼) CMS官方开发
Favicon.ico 在线制作
SWIG中文: SWIG是个帮助使用C或者C++编写的软件能与其它各种高级编程语言进行嵌入联接的开发工具。
前端教程资源
书栈网 - 前端|后端|移动端|数据库云计算&大数据|网络&系统&运维|UI&美工&设计|游戏开发|硬件&物联网|产品&运营&IDE|心灵毒鸡汤&必杀技

搭建个人博客¶

在线教育平台¶

优质资源¶

Gitee

指令参考手册¶

C/C++¶

文件名称	目标地址	提取码
Linux C 函数	百度网盘	qk9p
C语言函数速查表	百度网盘	q5xh
C/C++参考手册	百度网盘	hqbk

Linux¶

文件名称	目标地址	提取码
Linux命令搜索引擎	命令搜索
Linux命令大全	百度网盘	ci1e

Windows¶

文件名称	目标地址	提取码
DOS命令大全	百度网盘	nw4a

关于我¶

Name： Zhyantao
Addr： Tangshan China