笔记内容按照 中文文案排版指北 进行排版,以保证内容的可读性。
自动化排版工具 ,clone 下来之后,点击 index.html 就可以使用了。
利用 template 打造属于自己的 github 首页
准备模板
README.md.tpl 文件如下:
<h1 align="center">Hi 👋, I'm {{.Name}} ⏱️</h1>
<h3 align="center">{{.SelfDescription}}</h3>
<h2 align="center"><em>🌟 {{.Motto}}<em> 💪</h2>
<p align="center">
<img src="https://github-readme-stats.vercel.app/api?username={{.GithubName}}&theme=dracula&show_icons=true" alt="stats loading failure" width="380" height="152" />
<img src="http://github-readme-streak-stats.herokuapp.com?user={{.GithubName}}&theme=dracula&hide_border=false" alt="streak stats loading failure" width="380" height="152"/>
</p>
<p align="center">
<a href="https://github.com/ryo-ma/github-profile-trophy"><img src="https://github-profile-trophy.vercel.app/?username={{.GithubName}}" alt="profile loading failure" /></a>
</p>
<strong>Check out my work below!</strong>Time I contributed this year: 🎉<img src="https://img.shields.io/badge/wakatime-2178hrs_30mins-blue?logo=wakatime&color=blue">🎉
<h4 align="left">🔭 Check out what I'm currently working on {{.StudyContent}}</h4>
- {{.StudyContentDescription}} - 👀
<h4 align="left">🌱 Check out my recent projects</h4>
{{ range .RecentProjects -}}
- [{{.Name}}]({{.URL}}) - {{.Description}}
{{end}}
<h4 align="left">⚡ Check out what I’m currently learning </h4>
- {{ join .LearnTechAbility " And "}}
<h4 align="left">📫 How to reach me</h4>
- {{.Email}}
#### 🚧 My Todoist Stats: ⬇️👀
<details><summary><b>💡 more （about github❗）</b></summary>
<hr></hr>
### 🔮 Platform & Tools
[](https://www.apple.com/macos/big-sur/)
[](https://archlinux.org/)
[](https://www.mozilla.org/zh-CN/firefox/new/)
[](https://vercel.com/)
[](https://t.me/cloudnativer)
[](https://www.jetbrains.com/)
[](https://code.visualstudio.com/)
[](https://notion.so)
[](https://www.archlinux.org/)
[](https://www.apple.com/macos/big-sur/)
[](https://www.microsoft.com/windows/windows-11)
[](https://code.visualstudio.com/)
[](https://www.oneplus.com/)
[](https://www.apple.com/)
[](https://www.blackberry.com/)
[](https://webpack.js.org/)
[](https://reactjs.org/)
[](https://www.docker.com/)
[](https://yarnpkg.com/)
[](https://www.typescriptlang.org/)
[](https://www.w3.org/Style/CSS/)
[](https://lesscss.org/)
[](https://npmjs.com/)
[](https://postcss.org/)
[](https://html.spec.whatwg.org/)
[](https://git-scm.com/)
[](https://rollupjs.org/)
[](https://stylus-lang.com/)
[](https://www.serverless.com/)
[](https://www.linuxfoundation.org/)
[](https://www.ecma-international.org/)
[](https://vuejs.org/)
[](https://www.mongodb.com/)
[](https://nginx.org/)
[](https://nodejs.org/)
### 🗃️ Code & Skills
[](https://www.wireguard.com/)
[](https://kubernetes.io/)
[](https://www.docker.com/)
[](https://podman.io/)
[](https://prometheus.io/)
[](https://grafana.com/)
[](https://goharbor.io/)
[](https://www.consul.io/)
[](https://gohugo.io/)
[](https://www.linux.org/)
[](https://nginx.org/)
[](https://github.com/features/actions)
[](https://golang.org/)
[](https://ceph.io/)
[](https://www.ansible.com/)
[](https://www.markdownguide.org/)
</br>
</details>
🚀
解释一下：
第一行:介绍一下自己是谁
第二行:描述自己 (如 A passionate developer)
第三行:人生格言github-readme-stats:动态生成 GitHub 统计信息
github-readme-streak-stats:显示您的总贡献、当前连胜和最长连胜
github-profile-trophy:动态生成的 GitHub 奖杯
以上三个工具来自于更多资源 ,可以跟据个人需求自行选择第 13 行 taketime 是一个开发人员的自动时间跟踪工具,可以统计编码时间,类似的还有 Code time,在这里,只是放了一个静态的按钮,需要动态的话,可以自行弄 (个人感觉很麻烦且不太安全就没弄。。)
第 15 行:介绍一下当前研究方向是什么
第 16 行:简要描述一下目前研究方向的进展
19-21 行:描述一下你当前在 github 上正在做的项目
第 23 行:描述一下你当前正在学习的技术
第 26 行:你的电子邮箱,方便联系你
15-26 对自我的介绍可以跟据自己的需求进行更改,打造属于自己的风格。。28 行到最后:一些图标,有关你所使用的平台以及工具和语言以及技能的图标,还是比较全,如还要添加,可以自行去网上找。。
参照模板,准备配置文件
{
"Name": "某某某",
"SelfDescription": "A passionate developer",
"Motto": "You never lose, either you win or you learn!",
"GithubName": "xxx",
"StudyContent": "AI",
"StudyContentDescription": "None",
"RecentProjects": [
{
"Name": "hello",
"URL": "https://github.com/xxx/hello",
"Description": "Starting the repository study"
},
{
"Name": "test",
"URL": "https://github.com/xxx/test",
"Description": "Test Repository"
}
],
"LearnTechAbility": [
"Go language",
"cloud native technology"
],
"Email": "xxx@gmain.com"
}
//这里 RecentProjects 可以有多个,这里放了两个样例,可以自行更改
//正在学习的技术也可以有多个
定义对象
type Repo struct {
Name string `json:"Name"`
URL string `json:"URL"`
Description string `json:"Description"`
}
type TemplateA struct {
Name string `json:"Name"`
SelfDescription string `json:"SelfDescription"`
Motto string `json:"Motto"`
GithubName string `json:"GithubName"`
StudyContent string `json:"StudyContent"`
StudyContentDescription string `json:"StudyContentDescription"`
RecentProjects []Repo `json:"RecentProjects"`
LearnTechAbility []string `json:"LearnTechAbility"`
Email string `json:"Email"`
}
读取配置文件
func ReadConfig(filePath string) (data TemplateA, err error) {
var file *os.File
file, err = os.Open(filePath)
if err != nil {
fmt.Println("Error opening file:", err)
return
}
defer file.Close()
decoder := json.NewDecoder(file)
err = decoder.Decode(&data)
if err != nil {
fmt.Println("Error decoding JSON:", err)
return
}
return
}
主函数
var (
funcs = template.FuncMap{
"join": strings.Join,
}
)
func main() {
data, err1 := ReadConfig("./config.json")
if err1 == nil {
fmt.Println("读取配置文件成功!")
//fmt.Printf("%#v", data)
}
//注意 new(模板名)，应该和第一个文件名相同。new 和 ParseFiles 都会产生模板，模板要相关联才能建立成功。
tmpl := template.Must(template.New("README.md.tpl").Funcs(funcs).ParseFiles("./README.md.tpl"))
file, err2 := os.OpenFile("./README.md", os.O_TRUNC|os.O_WRONLY|os.O_CREATE, 0664)
if err2 != nil {
fmt.Println("create README.md failed, err:", err2)
return
}
if err3 := tmpl.Execute(file, data); err3 != nil {
fmt.Println("parse template failed, err:", err3)
}
}
完整 demo
package main
import (
"encoding/json"
"fmt"
"html/template"
"os"
"strings"
)
type Repo struct {
Name string `json:"Name"`
URL string `json:"URL"`
Description string `json:"Description"`
}
type TemplateA struct {
Name string `json:"Name"`
SelfDescription string `json:"SelfDescription"`
Motto string `json:"Motto"`
GithubName string `json:"GithubName"`
StudyContent string `json:"StudyContent"`
StudyContentDescription string `json:"StudyContentDescription"`
RecentProjects []Repo `json:"RecentProjects"`
LearnTechAbility []string `json:"LearnTechAbility"`
Email string `json:"Email"`
}
func ReadConfig(filePath string) (data TemplateA, err error) {
var file *os.File
file, err = os.Open(filePath)
if err != nil {
fmt.Println("Error opening file:", err)
return
}
defer file.Close()
decoder := json.NewDecoder(file)
err = decoder.Decode(&data)
if err != nil {
fmt.Println("Error decoding JSON:", err)
return
}
return
}
var (
funcs = template.FuncMap{
"join": strings.Join,
}
)
func main() {
data, err1 := ReadConfig("./config.json")
if err1 == nil {
fmt.Println("读取配置文件成功!")
//fmt.Printf("%#v", data)
}
//注意 new(模板名)，应该和第一个文件名相同。new 和 ParseFiles 都会产生模板，模板要相关联才能建立成功。
tmpl := template.Must(template.New("README.md.tpl").Funcs(funcs).ParseFiles("./README.md.tpl"))
file, err2 := os.OpenFile("./README.md", os.O_TRUNC|os.O_WRONLY|os.O_CREATE, 0664)
if err2 != nil {
fmt.Println("create README.md failed, err:", err2)
return
}
if err3 := tmpl.Execute(file, data); err3 != nil {
fmt.Println("parse template failed, err:", err3)
}
}
效果
效果还行,ok,完工了。。
扫一扫
408
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
