博客地址 https://huijunzhao-ds.github.io/dataking/
注册GitHub账号
https://github.com/join 需要邮箱,用户名,密码
注册后登录,可在右上角选择your profile然后左边的edit profile里面填写个人信息
告诉我你的GitHub账号,我把你加入到collaborators里面
本地电脑上安装git
Windows
自带(待确认)在开始菜单搜索cmd打开后输入git看是否能运行
MacOS
Linux(ubuntu)
克隆repo
在terminal(cmd)中运行(下文中所有出现的terminal对Windows系统都指cmd):
git clone https://github.com/huijunzhao-ds/dataking.git
cd dataking
本地电脑上预览网页(这部分可以跳过,或者在编辑分支后进行)
安装bundle及其他包
安装Ruby,官网教程https://www.ruby-lang.org/en/documentation/installation/
确定Gemfile在当前文件夹,在terminal中运行
gem install bundler
bundle install(这一步安装Gemfile里列的所有包)
运行本地服务器
bundle exec jekyll serve
在浏览器中打开 localhost:4000,对网站进行编辑后保存,刷新该界面即可浏览编辑的效果
建立自己的分支
clone完repo并cd到dataking文件夹后,在terminal里输入git status,应显示
on branch master(master是本地的最终分支,即最后呈现的结果)
your branch is up to date with origin/master (origin是远程的最终分支)
……
如果不是以上结果,先运行git pull更新本地的版本。
terminal里输入git checkout -b name (把name替换成你的分支名称,随便起,不与本地和远程的其他分支重复就好)
上述命令创建一个新的分支,并且切换到这个分支,该分支目前只在你的本地,对你本地的master分支和其他人的分支和远程的分支都没有影响。
编辑自己的分支
关于网页的格式内容等,有什么意见欢迎大家跟我说,我来改。希望大家在自己的分支上只做添加文档和编辑自己的文档等事情,不要修改整个网站。
创建新文档
在_posts文件夹里创建新文件,命名为“年-月-日-标题.md”(示例:2020-02-10-文章示例.md),保存。
在文件内第一行输入
—-
title: “”
comments: true or false
category:
—category1
—category2
……
tag:
—tag1
—tag2
……
—-
需添加标题(必需)分类和标签(非必需,可以多个),comments后面true的话可以评论,false则没有评论功能。
以上编辑运行后会在主页上产生文章和日期,并生成改文章的网页。
编辑文档
参考markdown文档编辑的语法(链接如下),编辑后记得保存。
https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
如果文档里要插入图片,将图片保存在assets/images文件夹里
commit编辑好的分支到远程
在terminal中cd到dataking文件夹,输入以下命令:
git status 查看更改,添加,删除过的文件
git add filename 添加修改,示例git add *.md (添加所有md格式的文件),git add —all(添加所有更改,慎用)
git commit -a -m “commit message” 提交更改,-a是all的简写, -m是message的简写,commit message替换成说明这次更改做了什么的信息,示例 git commit -a -m “add new post named …”, git commit -a -m “edit post named …, add pictures”
git push —set-upstream origin branch_name 将更改结果上传到远程的分支,branch_name替换成你自己的远程分支的名字
git branch checkout master 切换回master分支
git branch -d branch_name 本地删除该分支(该分支只是用来提交这次到编辑,下次重新创建分支)
pull request自己的编辑到master
我已将这个项目设置为在master branch上到更改必须经过pull request,PR必须有至少一个reviewer(有人愿意参与维护请联系我,这样我们就可以有多个reviewers)
加到collaborators里以后,可以到链接https://github.com/huijunzhao-ds/dataking,点击左上的new pull request,base选择master,compare选择你push时的branch_name, 填写title和comment,点击create pull request。把我的账号设为reviewer,如果你的更改与其他collaborator有关(合作编辑或用到他人的贡献)请把相关的人也加到reviewers里,并通知他们来review你的文章。
所有的reviewers都同意发布该编辑,编辑的结果会融合到master分支,然后在我们到网页上能看到,此时我会删除远程端到该分支。
附官方教程如下
https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request#creating-the-pull-request
https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review