使用Python编写并部署个人静态博客:(二)实现静态页面的输出

作者:J.sky · 发表于:
2023-04-20T10:15:27.000000Z
· 更新于:
2023-08-13T22:54:57.578620Z
· Tag: Python 碎言博客

使用Python编写并部署个人静态博客:(一)分析与设计

使用Python编写并部署个人静态博客:(二)实现静态页面的输出

使用Python编写并部署个人静态博客:(三)搜集博客数据

使用Python编写并部署个人静态博客:(四)逐步输出静态页面

使用Python编写并部署个人静态博客:(五)Python异步输出博文页面

实现静态页面的输出其实很简单,按着顺序来就行:搜集Markdown文件和站点配置文件->组织数据并渲染模板(jinja2)->输出HTML并保存到静态目录中。

最简单的静态文件输出

如果您想要向HTML文件添加字符串模板,您可以使用Python的字符串格式化功能。例如,如果您想要向HTML文件添加标题:

title = "My Title"
html_template = "<html><head><title>{0}</title></head><body>{1}</body></html>"
body = "<h1>hello world</h1>"
with open("file.html", "w") as f:
    f.write(html_template.format(title, body))

在此代码中,我们定义一个名为title的变量,其值为“My Title”,以及一个名为html_template的变量,其值为"{1}"。{0}和{1}是title和body变量的占位符,分别。然后,我们定义一个名为body的变量,其值为"hello world"。最后,我们以写入模式打开文件“file.html”,并使用format()方法将格式化的字符串写入其中。运行这段脚本后会在当前目录下生成一个file.html文件,内容如下:

<html><head><title>My Title</title></head><body><h1>hello world</h1></body></html>

至此,我们实现了一个简单的模板系统。

使用jinja2模板引擎

但是我们的站点不可能就只有一两个模板的变量,他会是由一系列的数据组成的,而且渲染的出来的HTML页面我们还需要进行布局和前端的美化,所以我们需要一个健壮的模板引擎。

Jinja 是一个快速、富有表现力、可扩展的模板引擎。模板中的特殊占位符允许编写类似于 Python 语法的代码。然后向模板传递数据以呈现最终文档。

安装

$ pip install Jinja2

通过上边的命令行,我们很容易就能安装jinja2的依赖文件。关于使用jinja2生成HTML有两个重要的步骤: 1. 组织jinja2的模板变量,也就是站点的上下文。 2. 编写jinja2的模板,这里包括模板的继承和模板的渲染,以及最后的保存输出。

jinja2的配置

# 设置jinja模板的所在目录
env = Environment(loader=FileSystemLoader(os.path.join("theme")))
context = {
    "title" : "hello",
    "body" : "world"
}
tmp = env.get_template("index.html")  # 获取对应的模板
sitemap_path = os.path.join('index.html')  # 输出静态文件
with open(sitemap_path, mode='w', encoding='utf-8') as f:
    f.write(tmp.render(**context))

这是一个最简单的jinja2模板的配置,我们所有的静态文件的输出都会使用这段代码。

编写jinja2模板

编写jinja2模板首先需要布局你的网站页面,先规划好博客需要的页面,因为博客的页面布局大体相同,所以要先写layout.html,通过模板的继承与引用来实现页面制作的分工,应避免把重复的内容写到多个页面。

jinja2语法

jinja2的语法很简单:

  1. 语句结构 {% %}
  2. 变量取值 {{ }}
  3. 注释 {# #}

输出页面的标题:

<h1>{{ title }}</h1>

循环输出标签:

{% for tag in tags %}
<samll>{{ tag }}</samll>
{% endfor %}

对于复杂的页面我们应该建立多个继承,对于固定的内容应当使用引用。

建立继承块:

<title>{{ blog_name_en }}-{{ blog_name }}{% block title %}{% endblock %}</title>

通过继承进行修改:

{% extends "layout.html" %}
{% block title %}-{{ title }}{% endblock %}
{# 此处省略了一些代码 #}

jinja2官方文档,这里可以查询到更多有关jinja2模板引擎的使用帮助。

组合到一起

通过一些列的操作,我们可以生成一些简单的HTML页面了,接下来我们来看看在Python中如何具体组织这些功能并实现他们。