https://github.com/Aleksi44/wagtailyoast

Wagtail + Yoast
https://github.com/Aleksi44/wagtailyoast

django wagtail yoast

Last synced: about 2 months ago
JSON representation

Wagtail + Yoast

• Host: GitHub
• URL: https://github.com/Aleksi44/wagtailyoast
• Owner: Aleksi44
• License: gpl-3.0
• Created: 2020-08-29T08:56:54.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-05-11T17:35:02.000Z (over 1 year ago)
• Last Synced: 2024-04-24T09:22:41.911Z (5 months ago)
• Topics: django, wagtail, yoast
• Language: Python
• Homepage: https://pypi.org/project/wagtailyoast/
• Size: 187 KB
• Stars: 31
• Watchers: 3
• Forks: 12
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-wagtail - Wagtail Yoast - A tool to improve readability of your texts with SEO recommendations. (Apps / SEO and SMO)

README

        
*****************

Wagtail Yoast SEO

*****************

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

    :target: https://pypi.org/project/wagtailyoast/

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

    :target: https://pypi.org/project/wagtailyoast/

`Yoastseo `_ + `Wagtail `_ = 🚀

Tested with :

- django==3.0.9

- wagtail==2.10.1

- yoastseo:1.80.0

.. image:: 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