wagtailembedder 1.2

# wagtailembedder [](https://pypi.python.org/pypi/wagtailembedder)

> Wagtail RichTextField 的片段嵌入器。

* 查看更多来自 Wagtail 社区的优秀包和资源 [Awesome Wagtail](https://github.com/springload/awesome-wagtail)。*


## 快速入门

使用以下命令安装软件包

```sh
pip install wagtailembedder
```

将 `wagtailembedder` 添加到您的 `settings.py` 中的 `INSTALLED_APPS` 部分

```python
INSTALLED_APPS = [
...
'modelcluster',
'wagtailembedder',
'core',
...
]
```

对于每个注册为 wagtail.wagtailsnippets 的模型，创建一个 html 文件以在 RichText 字段内渲染模板。

* 模板名称将与片段模型名称匹配，将大写字母替换为下划线，Wagtail 风格。*
对于 `core` 应用程序中的 `SocialMediaLink` 片段，它将查找以下模板 `core/templates/snippets/socialmedialink.html`。
* 模板中的变量是包含片段实例的 `snippet`。*

如果未定义模板，则在渲染包含嵌入片段的 RichTextField 时，前端将抛出异常。在开始嵌入之前，请确保为您的片段编写一些模板。

# 选项

如果片段元有描述字段，它将在管理员界面中显示在片段名称旁边。

```python
from django.db import models
import django.db.models.options as options

options.DEFAULT_NAMES = options.DEFAULT_NAMES + ('description',)


@register_snippet
class MySnippet(models.Model)
字段定义

class Meta
description = "我的片段描述"
```

## 开发

### 发布

- 为新版本的发布创建一个新的分支。
- 更新[变更日志](https://github.com/springload/wagtailembedder/CHANGELOG.md)。
- 根据 semver 更新 `setup.py` 中的版本号。
- 提交一个 PR 并将其 squash 合并。
- 在将 PR 合并到 master 后，使用 `make publish`（确认并输入您的密码）。
- 最后，转到 GitHub 并为新的版本创建一个发布和一个标签。
- 完成！