ABlog 快速入门¶
这个简短的博客工作流程假设你已经安装了 ABlog。如果没有,请看 安装 指南。
注意,这个帖子是一个工作草案。欢迎在 GitHub 上进行修改。
启动项目¶
要启动新的项目,在一个你想保存项目源文件的目录下运行: ablog start 命令。这个命令会问你几个问题并创建以下文件:
conf.py,包含用于构建 HTML 页面的项目配置。
first-post.rst,一个博客帖子的例子。
index.rst,包含你网站的 登陆 页的内容。
about.rst,另一个非帖子页面的例子。
构建与查看¶
不再拖延,让我们看看你的项目会是什么样子。首先运行 ablog build,将在你的项目文件夹中建立 HTML 页面于 _website 文件夹中。然后,调用 ablog serve 在你的默认网络浏览器中查看它们。关于这些命令的更多信息,请看 ABlog 命令。
你的登陆页是由 index.rst 建立的,包含了你的第一个帖子和关于页面的链接。请看 index.rst,了解一些关于项目内导航链接的小技巧。
撰写内容¶
If you are new to Sphinx and reStructuredText markup language, you might find reStructuredText Primer useful.
网页¶
你项目中的页面是 .rst 文件,只差一个 post 指令就能成为博客文章。为了使普通的页面能够从导航栏中访问,你需要将它们列在一个 toctree 中。这是为 about 页面显示的,进入 index.rst。
帖子¶
你可以用一个 post 指令将任何页面转换为一个帖子。ABlog 将负责在指定的档案库和侧边栏中列出帖子。
博客帖子¶
你可以用 ABlog 的 front-matter 或指令来新建博客文章。只需使用基于以下模板的东西作为 front-matter
:blogpost: true
:date: January 1, 2020
:author: A. Author
:location: World
:category: Blog
:language: English
:tags: blog
只需使用基于以下模板的东西作为 ABlog 的指令
.. post:: January 1, 2020
:author: A. Author
:location: World
:category: Blog
:language: English
:tags: blog
更多信息,请参阅 Posting with a Directive 和 Posting with page front-matter。
分析¶
ABlog uses Alabaster theme by default. You can use theme options to set your Google Analytics identifier to enable tracking.
配置¶
有四组主要的配置选项可以帮助你定制你的网站外观:
ABlog 配置选项 - 为你的博客添加博客作者、文章地点和语言,调整档案和 feed 内容等。
Options for HTML output - 配置你的网站的外观。
Alabaster 主题选项 – 链接到你的 GitHub 账户和项目,设置跟踪,等等。
其他文件夹¶
你可能已经注意到,你的项目包含三个文件夹,我们还没有提到。它们是:
_static是用来保存图片、.js和.css文件的,html_static_pathSphinx 选项的更多信息。
_templates是用于自定义 HTML 模板。更多信息见templates_path。
.doctree文件夹,在调用构建命令后创建,是 Sphinx 存储项目状态的地方。这个文件夹里的文件在你重建项目时可以节省时间。
评论¶
你可以通过创建一个 Disqus 账户并获得一个唯一的标识符,即
disqus_shortname,在你的网站上启用评论。请参阅 Disqus 集成 了解配置选项。