GitBlog 开源项目教程
gitblogPeople Die, but Long Live GitHub项目地址:https://gitcode.com/gh_mirrors/gi/gitblog
1. 项目的目录结构及介绍
GitBlog 项目的目录结构如下:
gitblog/
├── .github/
│ └── workflows/
│ └── deploy.yml
├── _config.yml
├── _posts/
│ └── example-post.md
├── _site/
├── assets/
│ ├── css/
│ │ └── style.scss
│ └── js/
│ └── script.js
├── index.html
├── about.md
├── README.md
└── .gitignore
目录结构介绍
- .github/workflows/deploy.yml: GitHub Actions 的工作流配置文件,用于自动化部署。
- _config.yml: 项目的配置文件,包含站点的基础配置信息。
- _posts/: 存放博客文章的目录,文章通常以 Markdown 格式编写。
- _site/: 生成的静态站点文件存放目录。
- assets/: 存放静态资源,如 CSS、JavaScript 文件等。
- index.html: 站点的首页文件。
- about.md: 关于页面的 Markdown 文件。
- README.md: 项目的说明文档。
- .gitignore: Git 忽略文件配置。
2. 项目的启动文件介绍
GitBlog 项目的启动文件主要是 index.html
。这个文件是站点的入口文件,负责加载必要的资源和渲染页面内容。
index.html 文件内容概览
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>GitBlog</title>
<link rel="stylesheet" href="assets/css/style.css">
</head>
<body>
<header>
<h1>GitBlog</h1>
</header>
<main>
<!-- 文章内容将在这里动态加载 -->
</main>
<footer>
<p>Copyright © 2023 GitBlog</p>
</footer>
<script src="assets/js/script.js"></script>
</body>
</html>
3. 项目的配置文件介绍
GitBlog 项目的配置文件是 _config.yml
。这个文件包含了站点的各种配置信息,如站点标题、描述、作者信息等。
_config.yml 文件内容示例
title: GitBlog
description: 一个简单的静态博客生成器
author: 你的名字
url: https://yourdomain.com
markdown: kramdown
theme: minima
配置项说明
- title: 站点的标题。
- description: 站点的描述。
- author: 站点的作者。
- url: 站点的 URL。
- markdown: 使用的 Markdown 解析器。
- theme: 使用的主题。
通过修改 _config.yml
文件,可以自定义站点的各种属性,以满足个性化需求。
gitblogPeople Die, but Long Live GitHub项目地址:https://gitcode.com/gh_mirrors/gi/gitblog