Metadata-Version: 2.1
Name: wagtail-guide
Version: 1
Summary: Adds functionality to add and edit a CMS guide page for editors.
Home-page: https://github.com/kevinhowbrook/wagtail_guide
Author: Kevin Howbrook - Torchbox
Author-email: kevin.howbrook@torchbox.com
License: MIT
Description: # Wagtail Guide
        [![CircleCI](https://circleci.com/gh/kevinhowbrook/wagtailguide.svg?style=shield&circle)](https://circleci.com/gh/kevinhowbrook/wagtailguide)
        
        ## What is it?
        
        ![gif eg](https://s3.gifyu.com/images/wg-eg.gif)
        
        ## Installation
        
        Wagtailguide has a pypi package and can be installed with:
        
        ```
        pip install wagtailguide
        ```
        
        After installing, add it to your settings file along with `wagtail.contrib.settings`, the settings inclusion should be placed with your other wagtail.contrib libraries:
        
        ```
        INSTALLED_APPS = [
            ...
            'wagtail_guide',
            'wagtail.contrib.settings',
        ]
        ```
        
        ## Usage
        To edit the guide, the user needs to be an admin, or have the `Manage editor guide` 'change' value checked in their user group permissions.
        
        ### Editing the guide
        To edit the guide, from the left hand menu open settings > then click 'Manage editor guide'. Edit your content and then save.
        
        ![guide edit](https://i.imgur.com/ZGRlu3I.png)
        
        #### Guide navigation menu
        If more than one 'heading' blocks are added to the content, an automatic menu will be displayed at the top of the guide under the heading 'Contents'
        
        ### Viewing the guide
        Once logged in, a new menu icon towards the bottom of the left hand menu will be visible labeled as 'Editor guide':
        
        ![guide view](https://i.imgur.com/HbCVvXy.png)
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
