igorw / balrog
小巧的静态网站生成器。
dev-master
2013-02-02 22:22 UTC
Requires
- lisphp/lisphp: 1.1.*@dev
- michelf/php-markdown: 1.3.*@dev
- silex/silex: 1.0.*@dev
- symfony/yaml: 2.1.*
- twig/twig: 1.9.*
This package is not auto-updated.
Last update: 2024-09-14 13:25:14 UTC
README
用 lisphp 编写的轻量级静态网站生成器。
使用方法
要开始一个新的网站,只需通过 composer 添加依赖项
$ composer init --require igorw/balrog:dev-master -n
现在您可以添加以下目录
-
assets: 所有这些文件都将复制到 Web 目录中。您可以将 JavaScript、CSS 和图片添加到这里。
-
layouts: 布局用于渲染页面。它们有
.html.twig
后缀。您可以创建基本模板,并使用extends
标签创建更多特定并扩展它们的模板。布局可以访问以下变量
-
post: 包含当前帖子的数据(在索引页面上未设置)。帖子有
title
、body
和任何额外的元数据。body
包含作为 html 渲染的 markdown 主体。 -
posts: 所有帖子的列表,按发表顺序反向排列。
遵循
index.$format.twig
命名方案的文件将被编译为index.$format
文件。 -
-
posts: 表示博客帖子的 markdown 文件。必须采用
YYYY-mm-dd-slug.md
格式,例如2012-09-20-like-a-hacker.md
。每个都必须以 YAML 前端元数据开始。以下是一个示例博客帖子--- layout: post title: Blogging Like a Hacker --- # Blogging Like a Hacker * I’m bloggin yo! * ORLY? * YARLY!
以下字段已定义
- title: 显示在索引上的博客帖子标题。
- layout: 用于渲染此帖子的布局。默认为
default
,这意味着将渲染layouts/default.html.twig
,除非指定其他布局。 - hidden: 将此设置为 true 以隐藏帖子从索引中。
可以定义其他字段并用于模板。
为了构建网站,您可以使用 balrog build
命令
$ vendor/bin/balrog build
这将使用一组可以部署到任何静态 Web 服务器的文件填充 static
目录。
每日名言
"飞吧,你们这些傻瓜!" - 干达夫