Skip to content

Aleksi44/wagtailyoast

Repository files navigation

Wagtail Yoast SEO

https://img.shields.io/pypi/v/wagtailyoast https://img.shields.io/pypi/pyversions/wagtailyoast

Yoastseo + Wagtail = 🚀

Tested with :

  • django==3.0.9
  • wagtail==2.10.1
  • yoastseo:1.80.0

https://d271q0ph7te9f8.cloudfront.net/www/images/screenshot-wagtail-yoast-.original.png

Setup

Install with pip :

pip install wagtailyoast

Add wagtailyoast to django apps installed :

INSTALLED_APPS = [
    ...
    'wagtailyoast',
]

Add locale used for Yoast and make sure you have STATIC_URL set up in your settings.py :

WY_LOCALE = 'en_US'
STATIC_URL = '/static/'

Add YoastPannel to your Page models :

from wagtail.admin.edit_handlers import TabbedInterface, ObjectList
from wagtailyoast.edit_handlers import YoastPanel


class TestPage(Page):
    ...
    keywords = models.CharField(default='', blank=True, max_length=100)

    edit_handler = TabbedInterface([
        ObjectList(Page.content_panels, heading=('Content')),
        ObjectList(Page.promote_panels, heading=('Promotion')),
        ObjectList(Page.settings_panels, heading=('Settings')),
        YoastPanel(
            keywords='keywords',
            title='seo_title',
            search_description='search_description',
            slug='slug'
        ),
    ])

YoastPanel params are :

  • keywords : Default keywords of the page.
  • title : 'Search Engine Friendly' title. This will appear at the top of the browser window.
  • search_description : 'Search Engine Friendly' description.
  • slug : URL of the page.

Development env

git clone [email protected]:Aleksi44/wagtailyoast.git
pip install -r requirements.txt

Run Django Server

python manage.py migrate
python manage.py init
python manage.py runserver 0.0.0.0:4243

Run Webpack Server

yarn
yarn start