Common StreamField blocks for Wagtail
Project description
# wagtailcommonblocks [![PyPI](https://img.shields.io/pypi/v/wagtailcommonblocks.svg)](https://pypi.python.org/pypi/wagtailcommonblocks)
> Common StreamField blocks for Wagtail.
*Check out [Awesome Wagtail](https://github.com/springload/awesome-wagtail) for more awesome packages and resources from the Wagtail community.*
## Quickstart
Assuming you have a [Wagtail](https://wagtail.io/) project up and running:
```sh
pip install wagtailcommonblocks
```
Add commonblocks to your `settings.py` in the INSTALLED_APPS section, before the core wagtail packages:
```python
...
'commonblocks',
'wagtail.contrib.wagtailsitemaps',
...
```
# Available blocks
* CommonPageChooserBlock
* SimpleRichTextBlock
* CommonImageBlock
* CommonQuoteBlock
* CommonHeadingBlock
* CommonVideoBlock
* CommonInternalLink
* CommonExternalLink
* CommonLinksBlock
You can override the headings of the `CommonHeadingBlock` block:
```python
...
COMMONBLOCKS_HEADING = (
('h1', 'h1'),
('h2', 'h2'),
)
```
## Development
### Releases
- Make a new branch for the release of the new version.
- Update the [CHANGELOG](https://github.com/springload/wagtailcommonblocks/CHANGELOG.md).
- Update the version number in `setup.py`, following semver.
- Make a PR and squash merge it.
- Back on master with the PR merged, use `make publish` (confirm, and enter your password).
- Finally, go to GitHub and create a release and a tag for the new version.
- Done!
> Common StreamField blocks for Wagtail.
*Check out [Awesome Wagtail](https://github.com/springload/awesome-wagtail) for more awesome packages and resources from the Wagtail community.*
## Quickstart
Assuming you have a [Wagtail](https://wagtail.io/) project up and running:
```sh
pip install wagtailcommonblocks
```
Add commonblocks to your `settings.py` in the INSTALLED_APPS section, before the core wagtail packages:
```python
...
'commonblocks',
'wagtail.contrib.wagtailsitemaps',
...
```
# Available blocks
* CommonPageChooserBlock
* SimpleRichTextBlock
* CommonImageBlock
* CommonQuoteBlock
* CommonHeadingBlock
* CommonVideoBlock
* CommonInternalLink
* CommonExternalLink
* CommonLinksBlock
You can override the headings of the `CommonHeadingBlock` block:
```python
...
COMMONBLOCKS_HEADING = (
('h1', 'h1'),
('h2', 'h2'),
)
```
## Development
### Releases
- Make a new branch for the release of the new version.
- Update the [CHANGELOG](https://github.com/springload/wagtailcommonblocks/CHANGELOG.md).
- Update the version number in `setup.py`, following semver.
- Make a PR and squash merge it.
- Back on master with the PR merged, use `make publish` (confirm, and enter your password).
- Finally, go to GitHub and create a release and a tag for the new version.
- Done!
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
wagtailcommonblocks-0.1.tar.gz
(11.6 kB
view details)
File details
Details for the file wagtailcommonblocks-0.1.tar.gz
.
File metadata
- Download URL: wagtailcommonblocks-0.1.tar.gz
- Upload date:
- Size: 11.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c279351db1bbcaf7c9a6ce3aaa9ce8dcd0184472ad32f325e247acfb8d82ff74 |
|
MD5 | 72f59b6000d879b0e9c385697ac6b0a3 |
|
BLAKE2b-256 | 71ca4d7fb541291de2ed90a0ac49c2a26f9007873cdff691b4149002828907d9 |