在GitHub Pages上使用Pelican搭建博客的教程

下面是“在GitHub Pages上使用Pelican搭建博客的教程”的完整攻略。

1. 准备工作

首先你需要在GitHub上面注册账号，并开通Pages服务。然后你需要安装Python和pip包管理工具，以及Pelican静态网站生成器。

安装Pelican可以使用pip来完成，命令如下：

pip install pelican markdown

2. 创建Pelican网站

接下来我们需要在本地创建一个基于Pelican的网站，可以使用pelican-quickstart快速创建。

打开终端，进入到你新建的博客站点目录下，运行以下命令：

pelican-quickstart

在运行命令的过程中，有一些问题需要你来回答：

What will be the title of this web site? [My Site]：自定义你博客的标题
Who will be the author of this site? [John Doe]：填写博客的作者名字
What will be the default language of this site? [en]：默认语言，可以直接按回车键
Do you want to specify a URL prefix? e.g., https://example.com (Y/n)：是否需要自定义站点URL，如果使用默认URL可以直接按回车键。
Do you want to enable article pagination? (Y/n)：是否启用文章分页，如果需要可以输入Y。
How many articles per page do you want? [10]：每页文章数量，可以自定义。
What is your time zone? [Europe/Paris]：设置时区，可以输入对应的时区名称，例如"Asia/Shanghai"。
Do you want to generate a Fabfile/Makefile to automate generation and publishing? (Y/n)：是否自动生成Makefile用来发布文章，可以输入Y。

按照提示完成以上问题的回答后，你就成功地创建了一个基于Pelican的博客站点。

3. 编写文章

在创建好的站点目录下，有一个名为content的文件夹，里面包含了一个示例博客文章的markdown文件，你可以基于这个示例来创建自己的文章。

Markdown是一种轻量级的标记语言，可以使用纯文本编辑器轻松书写，如果你不熟悉Markdown语法的话可以参考这篇文章。

在content文件夹下，你可以创建新的markdown文件作为新的博客文章，每篇文章需要包含以下基本元素：

Title：文章的标题
Date：发布日期
Category：文章分类
Author：作者（如果不填默认是你在快速设置中填写的名字）
Tags：标签
Slug：博客唯一标识符，请确保除博客标题以外的所有字符都是小写，使用连字符分隔单词（例如：my-first-blog-post）
Summary：文章简介，可以省略，如果留空，Pelican会自动截取正文前几行
前面加上7个“#”，表示一级标题
正文

示例代码如下:

Title: My First Blog Post
Date: 2022-01-01 10:00
Category: Blog
Tags: pelican, blog
Slug: my-first-blog-post
Author: John Doe

# My First Blog Post

Hello World! This is my first blog post created with Pelican.

4. 生成网站

文章写好之后，我们需要通过Pelican将所有的Markdown文件生成为静态网页。

在站点目录下，运行以下命令：

pelican content

以上命令将会生成所有Markdown文件对应的HTML文件，并且将它们放置在默认的output目录下。

如果你的文章内容发生了改变，可以再次运行pelican命令重新生成网页，如果生成的过程中不出现红色错误提示则表明生成成功。

5. 部署网站

在生成网页之后，最后一步就是将网站部署到GitHub Pages上面，这一步非常简单。

首先需要将站点目录下的output文件夹中的所有文件上传到你的GitHub Pages仓库中的gh-pages分支，可以使用Git命令或者GitHub Desktop等工具完成，具体方法如下：

cd output
git init
git remote add origin [GitHub Pages仓库地址]
git checkout -b gh-pages
git add .
git commit -m 'Initial commit'
git push origin gh-pages

接下来我们需要将站点中的配置文件pelicanconf.py修改为以下内容：

#!/usr/bin/env python
# -*- coding: utf-8 -*- #

AUTHOR = 'Your Name'
SITENAME = 'My Site'
SITEURL = 'https://[username].github.io/[repository_name]'

THEME = '[theme_name]'

PATH = 'content'

TIMEZONE = 'Asia/Shanghai'

DEFAULT_LANG = 'en'

# Disabling authors, categories, tags index pages
DIRECT_TEMPLATES = ['index', 'archives']

# Setting the slug format to /category/title/
SLUGIFY_SOURCE = 'basename'
ARTICLE_URL = '{category}/{slug}/'
ARTICLE_SAVE_AS = '{category}/{slug}/index.html'

# Theme-specific settings
[theme_settings]

其中需要将[username]和[repository_name]修改成你的GitHub账号名称和对应仓库名称，[theme_settings]是主题特定设置的选项，与主题有关，可以根据主题的要求进行相应的修改。

最后一步就是在GitHub Pages仓库的Settings选项卡中选择gh-pages分支作为默认分支，然后在浏览器中访问https://[username].github.io/[repository_name]/，就可以看到你的个人博客网站了。

6. 示例说明

下面我们来看两个使用Pelican搭建的个人博客的示例：

示例1：JosephBirrane

这是一位程序员的个人博客JosephBirrane，他使用Pelican搭建了这个博客，并且选择了Nest主题。

在这个博客中，JosephBirrane分享了很多关于Web开发和数据科学领域方面的文章，可以看到他是使用简单的Markdown语法来书写博客文章的。

他在博客中加入了不少有用的小工具，例如百度搜索、谷歌翻译、分享按钮等等，这些功能的实现都是通过主题的集成方法来完成的。

示例2：ChenChen's Blog

这是一位中国程序员的个人博客ChenChen's Blog，他同样使用Pelican搭建了这个博客，选择了Flex主题。

在这个博客中，ChenChen分享了很多关于数据科学、机器学习和统计学等方面的技术文章，同时也分享了自己的旅行和生活。

相比较于示例1，ChenChen做了一些特别的设置，例如自定义了头像和背景颜色，同时还添加了赞赏功能用于接受读者的打赏。

这些设置都是可以通过自己修改主题或者添加插件来完成的，如果你对自己的博客要求更高，可以尝试使用Pelican提供的自定义主题方法。

本站文章如无特殊说明，均为本站原创，如若转载，请注明出处：在GitHub Pages上使用Pelican搭建博客的教程 - Python技术站