Table of Contents
一、安装
为 bulid 指定 baseURL
二、目录结构
2.1 关于 “content”的目录结构
2.2 关于 config.php
三、Blade 模版
3.1 在 Blade 中使用 Markdown 语法
Regular HTML heading
3.2 生成 URLs
四、博客生成器
4.1 博客文章中的变量
@yield('post::title')
4.2 博客文章分页
五、Github Pages
Step 1:把 Katana 添加到除 master/gh-pages 分支之外的其他分支
Setp 2:生成站点
Step 3:把文件 Push 到 Step 1 中建立的分支
Step 4:把 public 目录添加到 master/gh-pages 分支
六、总结
项目 Github 地址
Home Backend Development PHP Tutorial Katana – 支持 Markdown 语法的 PHP 静态站点/博客生成器

Katana – 支持 Markdown 语法的 PHP 静态站点/博客生成器

Jun 23, 2016 pm 01:14 PM

目前已经有好几种静态站点生成器,如 Hexo、Jekyll等,今天发现一款使用 PHP 语法的静态博客生成器,支持 Markdown 语法,并且使用的是 Laravel 的 Blade 模版引擎。

Katana 的主要特点:

  • 支持 Markdown 语法
  • 快速安装
  • 自带 Pretty URLs
  • 简单的文章分页
  • 支持 Github Pages

一、安装

安装 Katana 非常简单,你只需运行 composer create-project命令:

composer create-project themsaid/katana your-site-name
Copy after login

现在你已经把 Katana 安装在了 your-site-name目录下,然后你需要运行下面的命令来生成站点:

cd your-site-namephp katana build
Copy after login

之后会在文件夹中生成一个 public 目录,里面就是生成的静态文件。

为 bulid 指定 baseURL

在生成静态文件时,可以通过 base_url来指定 baseUrl:

php katana build --base_url=/awesome-site
Copy after login

这样做的话,当你使用 Blade 的 @url()指令生成链接的时候会生成这样的 URLs: /awesome-site/about

二、目录结构

当运行 build命令后,会生成如下的文件结构:

  • content:这是 Katana 寻找你网站内容的地方
  • _cache:这是 Blade 保存编译完的视图文件的地方
  • public:Katana 会把生成的静态文件保存在这里
  • config.php:网站配置项

2.1 关于 “content”的目录结构

这个文件夹中保存的是你的 Blade 视图,静态文件(JS、CSS、图片等), _blog文件夹以及 _include文件夹。

_content文件夹是保存你 Blade 布局和基本视图的地方,Katana 不会为这些文件生成可访问的页面。

_blog文件夹是存放博客内容的地方。

2.2 关于 config.php

这个文件包含了 Katana 在生成静态文件是需要的一些预定义项,每一个配置项都有详细的说明,解释它们是用来做什么的。

你也可以在这个文件中定义任何变量,之后可以在网站的任何视图中调用该变量。

三、Blade 模版

如果你还不熟悉 Blade 模版的话,下面这段话是来自 Laravel 网站对它的介绍:

Blade 是一个由 Laravel 提供的简单但功能强大的模版引擎。同其他主流的 PHP 模版引擎不同的是,Blade 并不限制你在视图中使用纯 PHP 代码。

建议你到这里读一下 Blade 的文档。

3.1 在 Blade 中使用 Markdown 语法

Katana 为 Blade 添加了一个 @markdown指令,你可以这么使用它:

<h2 id="Regular-HTML-heading">Regular HTML heading</h2>@markdown    This is some **Markdown** content.@endmarkdown
Copy after login

3.2 生成 URLs

Katana 使用 Blade 的 @url()指令为页面和静态文件生成 URLs,这些 URLs 会基于运行 build时指定的 base_url参数:

@('/')                // Outputs '/'@('about')            // Outputs '/about'@('assets/style.js')  // Outputs '/assets/style.js'
Copy after login

四、博客生成器

使用 Katana 来生成博客非常简单,你只需在 /content/_blog文件夹总创建一个文件,并遵循下面格式命名:

2016-03-03-my-post-slug.blade.php
Copy after login

文件名前的日期是用来在文件系统中对文件进行排序的,同时还用来生成博客的 URL,上面的文件会生成下面的 URL:

blog.com/my-post-slug-20160303
Copy after login

4.1 博客文章中的变量

博客的视图看起来应该是下面这样:

@section('post::title', 'Stop Trying To Be Somebody')@section('post::date', 'February 28, 2016')@section('post_body')    <h2 id="yield-post-title">@yield('post::title')</h2>    <small>@yield('post::date')</small>    Post content here.@stop
Copy after login

以 post::开头的 Section 会添加到叫做 $blogPosts的全局变量中,这个变量可以在所有的视图中使用,并且它包含了文章对象的数组。

你可以使用这个变量来循环输出所有的博客文章:

@foreach($blogPosts as $blogPost)    <li>        <a href="{{ $blogPost->path }}">            {{ $blogPost->title }} at {{ $blogPost->date }}        </a>    </li>@endforeach
Copy after login

path属性是 Katana 自动添加的,它保存的是文章的相对 URL。

4.2 博客文章分页

Katana 分页显示博客的文章,你需要先在 config.php中设置 postsPerPage和 postsListView配置项。浏览一下配置文件就会知道每一个配置项是做什么用的。

在分页视图中, $paginatedBlogPosts变量包含了该页所有的文章,而 $nextPage和 $previousPage两个变量分别是后一页和前一页的链接。

五、Github Pages

你可以把站点部署到 Github Pages上,其想法是把 public目录作为你 Github Pages 库的主分支或者你其他库的 gh-pages分支。

Step 1:把 Katana 添加到除 master/gh-pages 分支之外的其他分支

我们这里把这个分支叫做 gh-pages-source,安装 Kanata 到该分支并按正常的步骤添加内容。

Setp 2:生成站点

当内容准备好之后就可以运行 build生成站点了:

php katana build
Copy after login

如果你不是使用的你的用户名的项目,则需要定义 base_url,如我的 Github 用户名为 9IPHP,但我没有把 Katana 发布到 9IPHP.github.com 这个项目,而是建立了一个 Katana 的项目,则需要这样生成站点:

php katana build --base_url=/Katana
Copy after login

Step 3:把文件 Push 到 Step 1 中建立的分支

首先需要移除 .gitignore文件中的 public这一行,否则该目录是提交不上去的,之后运行如下命令:

git add --allgit commit -m 'publishing website'git push origin gh-pages-source
Copy after login

Step 4:把 public 目录添加到 master/gh-pages 分支

git subtree push --prefix public origin master
Copy after login

或者:

git subtree push --prefix public origin gh-pages
Copy after login

六、总结

创建完成之后就可以到你的 Github Pages 中访问网站了,可以查看我创建的示例站点。

项目 Github 地址

Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

Video Face Swap

Video Face Swap

Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Tools

Notepad++7.3.1

Notepad++7.3.1

Easy-to-use and free code editor

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

Hot Topics

Java Tutorial
1653
14
PHP Tutorial
1251
29
C# Tutorial
1224
24
Explain JSON Web Tokens (JWT) and their use case in PHP APIs. Explain JSON Web Tokens (JWT) and their use case in PHP APIs. Apr 05, 2025 am 12:04 AM

JWT is an open standard based on JSON, used to securely transmit information between parties, mainly for identity authentication and information exchange. 1. JWT consists of three parts: Header, Payload and Signature. 2. The working principle of JWT includes three steps: generating JWT, verifying JWT and parsing Payload. 3. When using JWT for authentication in PHP, JWT can be generated and verified, and user role and permission information can be included in advanced usage. 4. Common errors include signature verification failure, token expiration, and payload oversized. Debugging skills include using debugging tools and logging. 5. Performance optimization and best practices include using appropriate signature algorithms, setting validity periods reasonably,

What are Enumerations (Enums) in PHP 8.1? What are Enumerations (Enums) in PHP 8.1? Apr 03, 2025 am 12:05 AM

The enumeration function in PHP8.1 enhances the clarity and type safety of the code by defining named constants. 1) Enumerations can be integers, strings or objects, improving code readability and type safety. 2) Enumeration is based on class and supports object-oriented features such as traversal and reflection. 3) Enumeration can be used for comparison and assignment to ensure type safety. 4) Enumeration supports adding methods to implement complex logic. 5) Strict type checking and error handling can avoid common errors. 6) Enumeration reduces magic value and improves maintainability, but pay attention to performance optimization.

Describe the SOLID principles and how they apply to PHP development. Describe the SOLID principles and how they apply to PHP development. Apr 03, 2025 am 12:04 AM

The application of SOLID principle in PHP development includes: 1. Single responsibility principle (SRP): Each class is responsible for only one function. 2. Open and close principle (OCP): Changes are achieved through extension rather than modification. 3. Lisch's Substitution Principle (LSP): Subclasses can replace base classes without affecting program accuracy. 4. Interface isolation principle (ISP): Use fine-grained interfaces to avoid dependencies and unused methods. 5. Dependency inversion principle (DIP): High and low-level modules rely on abstraction and are implemented through dependency injection.

How does session hijacking work and how can you mitigate it in PHP? How does session hijacking work and how can you mitigate it in PHP? Apr 06, 2025 am 12:02 AM

Session hijacking can be achieved through the following steps: 1. Obtain the session ID, 2. Use the session ID, 3. Keep the session active. The methods to prevent session hijacking in PHP include: 1. Use the session_regenerate_id() function to regenerate the session ID, 2. Store session data through the database, 3. Ensure that all session data is transmitted through HTTPS.

Explain late static binding in PHP (static::). Explain late static binding in PHP (static::). Apr 03, 2025 am 12:04 AM

Static binding (static::) implements late static binding (LSB) in PHP, allowing calling classes to be referenced in static contexts rather than defining classes. 1) The parsing process is performed at runtime, 2) Look up the call class in the inheritance relationship, 3) It may bring performance overhead.

What is REST API design principles? What is REST API design principles? Apr 04, 2025 am 12:01 AM

RESTAPI design principles include resource definition, URI design, HTTP method usage, status code usage, version control, and HATEOAS. 1. Resources should be represented by nouns and maintained at a hierarchy. 2. HTTP methods should conform to their semantics, such as GET is used to obtain resources. 3. The status code should be used correctly, such as 404 means that the resource does not exist. 4. Version control can be implemented through URI or header. 5. HATEOAS boots client operations through links in response.

How do you handle exceptions effectively in PHP (try, catch, finally, throw)? How do you handle exceptions effectively in PHP (try, catch, finally, throw)? Apr 05, 2025 am 12:03 AM

In PHP, exception handling is achieved through the try, catch, finally, and throw keywords. 1) The try block surrounds the code that may throw exceptions; 2) The catch block handles exceptions; 3) Finally block ensures that the code is always executed; 4) throw is used to manually throw exceptions. These mechanisms help improve the robustness and maintainability of your code.

What are anonymous classes in PHP and when might you use them? What are anonymous classes in PHP and when might you use them? Apr 04, 2025 am 12:02 AM

The main function of anonymous classes in PHP is to create one-time objects. 1. Anonymous classes allow classes without names to be directly defined in the code, which is suitable for temporary requirements. 2. They can inherit classes or implement interfaces to increase flexibility. 3. Pay attention to performance and code readability when using it, and avoid repeatedly defining the same anonymous classes.

See all articles