malenki/phantastic

一个像Ruby世界的Jekyll一样的静态博客生成器,但具有本地的标签、分类和区块。

dev-master 2014-04-26 15:23 UTC

This package is not auto-updated.

Last update: 2024-09-24 00:56:57 UTC


README

PHP静态博客生成器,类似于Jekyll,具有本地的标签、分类和区块。

如何安装它?

在安装和使用 Phantastic 之前,您必须安装 composer

您可以通过以下三种可能的方式安装 Phantastic

  • 通过下载 存档 的最新稳定版本。解压它,然后进入新创建的目录运行 composer update
  • 通过克隆git仓库 git clone https://github.com/malenkiki/phantastic.git,然后像之前一样解压后执行相同的操作。与之前不同的是,您将获得 dev-master 分支。
  • 使用composer一次性执行,如下所示:composer create-project malenki/phantastic your-project-name dev-master,其中 your-project-name 将是安装 Phantastic 的目录,然后您就可以开始使用它了。

它是如何工作的?

您可以使用命令行选项或编写一个YAML配置文件。

调用 ./phantastic --help 或不带参数以获取一些帮助。

我必须如何编写我的文章?

就像您已经使用Jekyll做的那样!您编写一些带有 YAML头部markdown文章文本文件,就是这样!

一篇文章必须至少有两个属性:layouttitle。前者给出要使用的模板名称,后者是文章的标题。

因此,这是一篇正确的最小文章

    ---
    layout: my-template
    title: Some Very Important Heading
    ---

    # Blah Blah

    A short sentence.

告诉我更多关于区块的信息...

区块是使用markdown语法编写的 文本片段

这些文件被保存在它们自己的目录中。

在模板PHP文件中,您可以像您想要的那样调用这些区块,遵循文章的一些标签,或者直接调用。

因此,所有文本都可以在模板之外定义。

告诉我更多关于分类的信息...

分类是通过在文章目录中使用的 目录层次结构 自动定义的。但是,您也可以通过使用 YAML配置文件 将这些目录关联到其他名称。

要将目录链接到其正确的名称,执行以下操作,例如

    categories
        some_dir: My Category
        some_other_dir: Another Category Name
        last_butnot_the_least_dir: This Category Is A Must Have!

告诉我更多关于标签的信息...

好吧,标签就是…标签 :) 您可以在YAML头部为每篇文章定义一些标签,如下所示

    tags:
        - foo
        - bar
        - something

因此,当生成器运行时,它会创建标签页面,并有一个可用的标签云!

自定义YAML头部属性

是的,您可以将任何您想要的内容添加到YAML头部以供以后在模板中使用。

告诉我更多!

以后…我必须在继续文档之前先改进这个项目,但它像您在这里看到的示例一样是可用的:[http://www.decouverte-patrimoine.fr/](http://www.decouverte-patrimoine.fr/)