前言
此文章是笔者在 github 使用中的一些经验性总结,学习的新姿势会同步更新,记录。
目录
可访问性
你可以正常访问 github.com
网页并且正常提交代码吗?
1、关于正常访问网页版
下面是通过修改本地 hosts 文件的方式增强访问,推荐采用网络代理方案。
- GitHub520 - 😘 让你“爱”上 GitHub,解决访问时图裂、加载慢的问题。(无需安装)raw.hellogithub.com/
- SwitchHosts - Switch hosts quickly!
2、关于正常提交代码
git.exe push --progress "origin" master:master
fatal: unable to access 'https://github.com/yanyue404/...': OpenSSL SSL_read: Connection was reset, errno 10054
git push 的时候一直报错 443TimeOut, 这是网络的问题,需要配置一个可以访问外网的 git 代理,就可以提交了。
展示自己的项目
借助 Github 平台展示项目
(1)gh-pages 分支托管
在自己的 github 项目上添加gh-pages
分支,并保证里面有需要展示的代码,以index.html
作为入口就可以展示项目了, 展示地址就是 Github 用户名.github.io/创建的仓库名。
将本项目下的 dist 文件夹内容发布到远端的 gh-pages
分支
git subtree push --prefix=dist origin gh-pages
或者使用 shell 脚本上传:
deploy.sh
#!/usr/bin/env sh
# 确保脚本抛出遇到的错误
set -e
# 生成静态文件
npm run build
# 进入生成的文件夹
cd docs/.vuepress/dist
# 如果是发布到自定义域名
# echo 'www.example.com' > CNAME
git init
git add -A
git commit -m 'deploy: vuepress docs'
# 如果发布到 https://<USERNAME>.github.io
git push -f https://github.com/yanyue404/mingdao.git master:gh-pages
cd -
例子:
(2)角落的Fork me on GitHub
标签 —— github-corners
(3)Logo
为自己的项目添加一个漂亮的 Logo。
(4)README
为自己的项目写一个 README.md
的 markdown 说明文件
- #171 我的 markdown 写作风格改进 :以《中文技术文档的写作规范》为标准
- 中文技术文档的写作规范 by ruanyifeng
- guodongxiaren/README README 文件语法解读
- emoji-list/ github 支持的 emojj 表情
- GitHub 上 README 中的漂亮徽章
专业指引
- Github 官网 help / 基础中文翻译
- Git 飞行规则(Flight Rules)
- GitHub 秘籍
- GotGitHub: an open source E-book about GitHub in Chinese
- GitHub 漫游指南,by phodal
其他物料
1、开源团队
(1)国内:
(2)国外:
- Github 平台的开源 API
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。