Django Page CMS 技术文档

1. 安装指南

1.1 使用 pip 安装

Django Page CMS 可以通过 pip 快速安装。执行以下命令即可：

pip3 install "django-page-cms[full]"

安装完成后，可以使用以下命令创建一个示例网站：

gerbi --create mywebsite

1.2 使用 Docker 安装

如果你更喜欢使用 Docker 进行安装，可以按照以下步骤操作：

1. 启动 Docker 容器：

   docker compose up fast
   

   或者，如果你想自己构建镜像：

   docker compose up web
   

2. 创建超级用户账户：

   docker compose run fast python example/manage.py createsuperuser
   

3. 创建一个演示网站：

   docker compose run fast python example/manage.py pages_demo
   

4. 运行测试：

   docker compose run run-test
   

2. 项目使用说明

2.1 页面管理

Django Page CMS 允许你以简单而强大的方式创建和管理分层页面。每个页面都可以有不同的模板，并且支持不同的占位符（Placeholders）。

2.2 占位符（Placeholders）

占位符是 Django Page CMS 的核心概念之一。你可以在页面模板中使用占位符标签，这样在页面管理界面中，这些占位符字段会动态显示。每个页面可以根据需要选择不同的模板和占位符。

2.3 内联编辑

Django Page CMS 支持内联编辑功能，允许你在前端页面直接编辑内容，而无需进入后台管理界面。

3. 项目 API 使用文档

3.1 页面模型（Page Model）

Django Page CMS 提供了丰富的 API 来管理页面。你可以通过 Page 模型来创建、更新和删除页面。

from pages.models import Page

# 创建新页面
new_page = Page.objects.create(title="My New Page", slug="my-new-page")

# 更新页面
new_page.title = "Updated Page Title"
new_page.save()

# 删除页面
new_page.delete()

3.2 占位符 API

占位符 API 允许你在模板中动态插入内容。你可以通过 Placeholder 标签在模板中定义占位符，并在后台管理界面中编辑这些占位符的内容。

{% load pages_tags %}

<div>
    {% placeholder "content" %}
</div>

4. 项目安装方式

4.1 通过 pip 安装

推荐使用 pip 进行安装：

pip3 install "django-page-cms[full]"

4.2 通过 Docker 安装

使用 Docker 安装可以简化部署过程：

docker compose up fast

4.3 手动安装

如果你需要手动安装，可以按照以下步骤操作：

1. 克隆项目仓库：

   git clone https://github.com/batiste/django-page-cms.git
   

2. 进入项目目录并安装依赖：

   cd django-page-cms
   pip3 install -r requirements.txt
   

3. 运行项目：

   python manage.py runserver
   

通过以上步骤，你可以顺利安装并使用 Django Page CMS 项目。