# @apostrophecms/blog 中文文档

规范地址：https://npmcn.com/package/%40apostrophecms/blog/

版本：1\.0\.6
npm 元数据更新时间：2026-10-20T16:55:18.439Z
中文译文更新时间：2026-11-06T21:33:53.097Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40apostrophecms/blog
原文对照：https://npmcn.com/package/%40apostrophecms/blog/?lang=original
项目主页：https://github.com/apostrophecms/blog#readme
源码仓库：https://github.com/apostrophecms/blog

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：21 kB，19 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2022-10-03T15:05:13.203Z
- 最新版本发布：2025-09-03T13:51:21.151Z
- 近 30 天下载量：2313（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

ApostropeCMS 网站的博客模块

## 安装

```sh
npm install @apostrophecms/blog
```

也可以使用：`pnpm add @apostrophecms/blog`、`yarn add @apostrophecms/blog`、`bun add @apostrophecms/blog`

## README

![ApostropheCMS logo](https://raw.githubusercontent.com/apostrophecms/apostrophe/main/logo.svg)

# Aposrophe 博客

 [![](https://img.shields.io/badge/MADE%20FOR%20ApostropheCMS-000000.svg?style=for-the-badge&logo=Apostrophe&labelColor=6516dd)](https://docs.apostrophecms.org/)[![](https://img.shields.io/discord/517772094482677790?color=5865f2&label=Join%20the%20Discord&logo=discord&logoColor=fff&labelColor=000&style=for-the-badge&logoWidth=20) ](http://chat.apostrophecms.org/)[![](https://img.shields.io/static/v1?style=for-the-badge&labelColor=000000&label=License&message=MIT&color=3DA639)](https://github.com/apostrophecms/blog/blob/main/LICENSE.md)

**将博客功能添加到 ApostropeCMS 站点** 有文章管理,基于日期的过滤,以及多个博客支持. 提供博客作品类型和页面模板以快速启动.

## 特征

-   **QQ 博客文章管理** - 完成有出版日期的博客文章的 CRUD 界面
-   **QQ 基于日期的过滤** - 建造用于档案和导航的年/月/日查询过滤器
-   **完全自定义** —— 覆盖模板, 添加字段, 并样式以匹配您的品牌
-   **QQ 多个博客类型** - 扩展创建不同的博客类别(新闻、更新等)
-   **\* 出版物管制** - 文章只出现在过去公布的日期

## 安装

要安装模块, 请使用命令行在 Aposrope 项目的根目录中运行此命令 :

```bash
npm install @apostrophecms/blog
```

## 使用量

配置您的博客模块 `app.js` 文件 :

```javascript
import apostrophe from 'apostrophe';

export default apostrophe({
  root: import.meta,
  shortName: 'my-project',
  bundles: [ '@apostrophecms/blog' ],
  modules: {
    '@apostrophecms/blog': {},
    '@apostrophecms/blog-page': {}
  }
});
```

### 启用页面类型

在您的页面配置中添加博客页面类型 :

```javascript
// modules/@apostrophecms/page/index.js
export default {
  options: {
    types: [
      {
        name: '@apostrophecms/home-page',
        label: 'Home'
      },
      {
        name: '@apostrophecms/blog-page',
        label: 'Blog'
      }
    ]
  }
};
```

## 自定义模板

包含的模板`index.html`, (中文(简体) ), `show.html`, (中文(简体) ), `filters.html`表明现有数据的起点。 在您执行您自己的样式和布局的项目中覆盖它们 :

```
modules/
├── @apostrophecms/
│   └── blog-page/
│       └── views/
│           ├── index.html      # Blog listing page
│           ├── show.html       # Individual blog post
│           └── filters.html    # Date filtering controls
```

## 基于日期的过滤

博客包括内置查询过滤器

| 过滤器 | 格式 | 实例 URL |
| --- | --- | --- |
| `year` | `YYYY` | `/blog?year=2024` |
| `month` | `YYYY-MM` | `/blog?month=2024-03` |
| `day` | `YYYY-MM-DD` | `/blog?day=2024-03-15` |

### 出版物管制

博客文章使用 `publishedAt` 字段来控制能见度。 公共网站上只刊登过去有出版日期的文章。 编辑器可以在管理界面中看到所有的文章.

> **说明:** 这不会在出版日期自动公布修改草案. 关于预定出版内容草案,请考虑 [@ apostrophycms/ 预定出版](https://apostrophecms.com/extensions/scheduled-publishing) 模块.

## 多个博客类型

有时一个网站需要多种,独特的博客文章. 如果可以一起管理博客类型 [添加新字段](https://docs.apostrophecms.org/guide/content-schema.html#using-existing-field-groups) 财务报告和审定财务报表 [查询构建器](https://docs.apostrophecms.org/reference/module-api/module-overview.html#queries-self-query) 以自定义博客视图。 但是如果博客的帖子类型应该完全分开管理,那么也许最好为每个版本创建单独的片子类型.

### 创建自定义博客类型

```javascript
// modules/news-blog/index.js - for news articles
export default {
  extend: '@apostrophecms/blog',
  options: {
    label: 'News Article',
    pluralLabel: 'News Articles'
  },
  fields: {
    add: {
      priority: {
        type: 'select',
        choices: [
          { label: 'Standard', value: 'standard' },
          { label: 'Breaking', value: 'breaking' },
          { label: 'Featured', value: 'featured' }
        ]
      },
      source: {
        type: 'string',
        label: 'News Source',
        help: 'Original source of this news item'
      }
    },
    group: {
      basics: { fields: ['priority', 'source'] }
    }
  }
};
```

每个博客类型都需要相应的页面类型来扩展 `@apostrophecms/blog-page`数字 :

```javascript
// modules/news-blog-page/index.js - page type for news articles
export default {
  extend: '@apostrophecms/blog-page'
};
```

### 自定义博客类型模板

每个博客类型都可以有自己的模板. 在相应的页面模块中创建它们 :

```
modules/
├── news-blog-page/
│   └── views/
│       ├── index.html      # News listing page
│       ├── show.html       # Individual news article
│       └── filters.html    # Custom filters for news
└── @apostrophecms/
    └── blog-page/
        └── views/
            ├── index.html  # Default blog listing
            └── show.html   # Default blog post
```

这样你就可以:

-   风格与正常博客文章不同
-   添加针对新闻内容的自定义过滤选项
-   为每个博客类型显示不同的字段或布局
-   创建独特的导航和用户体验

当博客类型不同时

-   **内容结构** - 新闻报道与技术辅导与公司公告
-   **编辑工作流程** - 管理不同内容类型的不同团队
-   **显示要求** - 独特的造型、过滤或组织需要
-   **URL 模式** - 说吧 `/blog/`, (中文(简体) ), `/news/`, (中文(简体) ), `/updates/` 具有独特的导航功能

## 实地参考

博客作品类型默认包括这些字段:

-   **标题** (单位:千美元)`title`\- 文章标题
-   **粘贴** (单位:千美元)`slug`\- 方便URL标识符
-   **发布日期** (单位:千美元)`publishedAt`\- 控制公众可见度
-   **内容** (单位:千美元)`body`) - 丰富文本内容区域
-   **元描述** (单位:千美元)`metaDescription`\- SEO描述
-   **标记** (单位:千美元)`tags`\- 分类分类

* * *

## _由ApostropeCMS团队所建._

**发现这个有用吗?** [给我们一颗巨星](https://github.com/apostrophecms/blog) ⭐

## 常见问题

### @apostrophecms/blog 是什么？

ApostropeCMS 网站的博客模块

### 如何安装 @apostrophecms/blog？

在项目目录运行 npm install @apostrophecms/blog，或使用 pnpm add / yarn add / bun add。

### @apostrophecms/blog 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/apostrophecms\_\_blog 是否存在。

### @apostrophecms/blog 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @apostrophecms/blog 可以商用吗？

@apostrophecms/blog 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @apostrophecms/blog 的下载量有多少？

根据 npm 官方下载统计，@apostrophecms/blog 在 2026/10/07 – 2026/11/05 这 30 天内被下载 2,313 次，日均约 77 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @apostrophecms/blog 还在维护吗？

最新版本 1\.0\.6 发布于 2025/09/03（1\.2 年前）；至今共发布 7 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/10/03。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

