SublimePelican: Pelican 集成到 Sublime Text

SublimePelican 是一个 Sublime Text 插件，它使编写 Pelican 文章更轻松和更快。

该插件为您准备好元数据字段，具有填写当前日期、生成缩写名以及列出您已使用过的类别和标签的功能。更多功能将被添加。更多功能

安装

使用 Package Control 安装

安装在 SublimePelican 最简单的方法是使用 Will Bond 的 Sublime Package Control。Package Control 可自动为您更新 SublimePelican 到最新版本。

1. 如果您尚未安装 Sublime Package Control，请按照以下步骤进行操作： http://wbond.net/sublime_packages/package_control/installation
2. 打开 Sublime Text 并打开命令面板（OS X: Command+Shift+P；Linux/Windows: Control+Shift+P）。
3. 选择“Package Control: Install Package”，等待 Package Control 获取包列表。
4. 当快速面板出现列表时，键入 Pelican 以选择 Pelican。

无 Git 安装

1. 从 GitHub 下载最新源代码。
2. 将 sublime-pelican-master 文件夹复制到您的 Sublime Text Packages 目录中。
3. 将 sublime-pelican-master 文件夹重命名为 Pelican。

如果您不确定 Sublime Text Packages 目录的位置，请打开 Sublime Text 并选择菜单项 首选项 > 浏览包…

使用 Git 安装

将此存储库克隆到您的 Sublime Text Packages 目录中

git clone https://github.com/jsliang/sublime-pelican.git
mv sublime-pelican Pelican

这相当于

git clone https://github.com/jsliang/sublime-pelican.git Pelican

如果您不确定 Sublime Text Packages 目录的位置，请打开 Sublime Text 并选择菜单项 首选项 > 浏览包…

使用方法

从命令面板访问命令

1. 安装后，打开命令面板（OS X: Command+Shift+P；Linux/Windows: Control+Shift+P）。
2. 在命令面板中键入 Pelican，查看可用命令列表。

从上下文菜单访问命令

在正在编辑的文件上右键单击，并访问 SublimePelican 项下的命令。

SublimePelican 命令

• pelican：新建文章（Markdown） 和 pelican：新建文章（reStructuredText）

  这些命令将打开一个新文章，并预先设置好元数据字段。

  元数据将根据您的元数据模板生成。有关元数据模板定制的说明，请参考设置 > 可定制元数据模板。

• pelican：插入元数据

  此命令在当前打开的文章文件中插入并重新组织元数据字段。元数据字段按照您的元数据模板定义的顺序列出。

  如果打开的文章中存在元数据字段，则此命令保留这些字段值。未列在元数据模板中的字段也将保留。

• pelican：插入类别

  

  如果您在写文章时难以记住使用过的类别，那么这个命令就适合您。该命令在快速面板中列出您在 Pelican 网站中使用过的类别，允许您快速模糊选择并插入之前使用过的类别。

• pelican：插入标签

  

  如果您在写文章时难以记住使用过的标签，那么这个命令就适合您。该命令在快速面板中列出您在 Pelican 网站中使用过的标签，允许您快速模糊选择并插入之前使用过的标签。

• pelican：更新文章日期

  此命令将日期元数据字段更新为当前日期和时间。

• pelican：使用标题更新缩略名

  此命令从文章标题生成缩略名字段。注意：在 Sublime Text 2 中，非 ASCII 字符会被忽略（详见问题#1）。

设置

有关 SublimePelican 可用的最新设置信息，请选择菜单项 首选项 > 包设置 > SublimePelican > 设置 - 默认。

请不要编辑“设置 - 默认”中的设置，因为更新 SublimePelican 时更改将会丢失。相反，请在 首选项 > 包设置 > SublimePelican > 设置 - 用户 中自定义设置。

智能元数据字段生成

缩略名生成

• force_slug_regeneration

  默认情况下，如果文章中已定义缩略名，则不会自动生成缩略名。设置为 true 用于强制缩略名重新生成。

  默认值：false

• generate_slug_from_title

  • 设置为 "none" 以禁用缩略名生成

  • 设置为 "title_change" 以在文章标题更改时生成缩略名

    注意，当设置为 "title_change" 时，即使设置了 force_slug_regeneration 为 false，每次在标题行中输入时，缩略名也将被重新生成。

  • 设置为 "save" 以在保存时生成缩略名

    默认情况下，如果文章中已定义缩略名，则不会自动生成缩略名。这是为了避免不希望的缩略名变化。如果您希望在每次保存时强制缩略名重新生成，您必须将 force_slug_regeneration 设置为 true。

  默认值："save"

可定制元数据模板

• article_metadata_template

  Markdown 和 reStructuredText 文章的元数据模板。

  默认值

{
    // Metadata template for Markdown articles
    "md":
        [
            "Title: %(title)s",
            "Slug: %(slug)s",
            "Date: %(date)s",
            "Tags: %(tags)s",
            "Category: %(category)s",
            "Author: %(author)s",
            "Lang: %(lang)s",
            "Summary: %(summary)s"
        ],

    // Metadata template for reStructuredText articles
    "rst":
        [
            ":title: %(title)s",
            ":slug: %(slug)s",
            ":date: %(date)s",
            ":tags: %(tags)s",
            ":category: %(category)s",
            ":author: %(author)s",
            ":lang: %(lang)s",
            ":summary: %(summary)s"
        ]
}

Pelican 文章的文件路径过滤器

为了防止自动缩略名的生成无端影响其他 Markdown/reStructuredText 文件（这些文件不是 Pelican 文章），SublimePelican 仅处理配置在 Pelican Makefile 中的 INPUTDIR 目录下的 Markdown/reStructuredText 文件。

• use_input_folder_in_makefile

  当设置为 false 时，SublimePelican 将使用在 filepath_filter 中定义的正则表达式作为 Pelican 文章的文件路径过滤器。

  默认值：true

• filepath_filter

  Pelican 文章的文件路径过滤器，用 Python 正则表达式编写。仅在将 use_input_folder_in_makefile 设置为 false 时有效。

  默认情况下，只有位于 content/ 目录下的 Markdown/reStructuredText 文件被视为 Pelican 文章文件。

  默认值："content/.*\\.(md|markdown|mkd|rst)$"

意见与错误报告

如果您有任何意见，或者在发现任何错误时，请自由地将其发布在 问题 中。

感谢

• Pelican
• Sublime Text
• Sublime Package Control

许可证

SublimePelican 采用 MIT 许可证授权。

版权所有 © 2013，Jui-Shan Liang <[email protected]>

特此授予，任何获得此软件及其相关文档（“软件”）副本的个人免费权利，使用该软件，包括但不限于以下权利：使用、复制、修改、合并、发布、分发、许可和/或销售软件副本，并允许任何人获得软件副本的人这样做，但受以下条件约束

上述版权声明和本许可声明应包含在软件的所有副本或实质性部分中。

本软件按“原样”提供，不提供任何明示或暗示的保证，包括但不限于适销性、特定用途的使用和侵权保证。在任何情况下，作者或版权所有者都无需对索赔、损害或其它责任负责，无论此类责任由合同、侵权行为还是其它行为引起，无论此类责任是否与软件或其使用或其它方式相关。