{"id":19951254,"url":"https://github.com/torchbox/wagtailguide","last_synced_at":"2026-03-11T15:13:42.045Z","repository":{"id":34915849,"uuid":"187364477","full_name":"torchbox/wagtailguide","owner":"torchbox","description":"An app for adding a CMS guide to your Wagtail CMS","archived":false,"fork":false,"pushed_at":"2024-05-22T03:06:33.000Z","size":1222,"stargazers_count":25,"open_issues_count":3,"forks_count":9,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-01T03:28:54.659Z","etag":null,"topics":["wagtail"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/torchbox.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-18T13:58:53.000Z","updated_at":"2025-01-15T22:53:48.000Z","dependencies_parsed_at":"2024-05-22T03:30:12.115Z","dependency_job_id":"11e93bf8-daa9-4b30-ae98-24e95c86788b","html_url":"https://github.com/torchbox/wagtailguide","commit_stats":null,"previous_names":["torchbox/wagtailguide","kevinhowbrook/wagtailguide"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/torchbox/wagtailguide","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/torchbox%2Fwagtailguide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/torchbox%2Fwagtailguide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/torchbox%2Fwagtailguide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/torchbox%2Fwagtailguide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/torchbox","download_url":"https://codeload.github.com/torchbox/wagtailguide/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/torchbox%2Fwagtailguide/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30385377,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-11T14:10:17.325Z","status":"ssl_error","status_checked_at":"2026-03-11T14:09:37.934Z","response_time":84,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["wagtail"],"created_at":"2024-11-13T01:07:19.619Z","updated_at":"2026-03-11T15:13:42.030Z","avatar_url":"https://github.com/torchbox.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Wagtail Guide\n\n![tests](https://github.com/torchbox/wagtailguide/workflows/Test/badge.svg) [![codecov](https://codecov.io/gh/kevinhowbrook/wagtailguide/branch/master/graph/badge.svg?token=K2XKBfubBh)](https://codecov.io/gh/kevinhowbrook/wagtailguide)\n\n## What is it?\n\nThe Wagtail Guide app adds functionality for creating and editing a guide for editors and publishers to help them create good content.\n\n## Installation\n\nWagtailguide has a pypi package and can be installed with:\n\n```bash\npip install wagtail-guide\n```\n\nAfter installing, add it to your settings file along with `wagtail.contrib.settings`, the settings inclusion should be placed with your other wagtail.contrib libraries:\n\n```python\nINSTALLED_APPS = [\n    ...\n    'wagtail_guide',\n    'wagtail.contrib.settings',\n]\n```\n\n## Settings and configuration\n\nWagtail guide has some customisation options...\n\n**WAGTAIL_GUIDE_MENU_LABEL**\nUse this setting to define your own menu label for viewing the guide.\n\n**ADD_WAGTAIL_GUIDE_TO_HELP_MENU**\nThis setting will place the guide within the 'Help' menu.\n\n**HIDE_WAGTAIL_CORE_EDITOR_GUIDE**\nYou can use this setting to turn off the Wagtail core Editor Guide link\n\n### Examples of customisation via settings\n\nHere is an example of a custom menu label (outlined here in orange),\nand placing the editor guide link in the help menu:\n\n```python\nWAGTAIL_GUIDE_SETTINGS = {\n    \"ADD_WAGTAIL_GUIDE_TO_HELP_MENU\": True,\n    \"WAGTAIL_GUIDE_MENU_LABEL\": \"CMS Publishing Guide\",\n    \"HIDE_WAGTAIL_CORE_EDITOR_GUIDE\": False,\n}\n```\n\n![custom label](screenshots/custom-label.png)\n\nHere is an example of hiding the core Editor Guide link and just using ours:\n\n```python\nWAGTAIL_GUIDE_SETTINGS = {\n    \"ADD_WAGTAIL_GUIDE_TO_HELP_MENU\": True,\n    \"WAGTAIL_GUIDE_MENU_LABEL\": \"CMS Publishing Guide\",\n    \"HIDE_WAGTAIL_CORE_EDITOR_GUIDE\": True,\n}\n```\n\n![remove help](screenshots/remove-help.png)\n\nYou can define them in your project settings file like this:\n\n```python\nWAGTAIL_GUIDE_SETTINGS = {\n    \"ADD_WAGTAIL_GUIDE_TO_HELP_MENU\": False,\n    \"WAGTAIL_GUIDE_MENU_LABEL\": \"WG guide menu label\",\n    \"HIDE_WAGTAIL_CORE_EDITOR_GUIDE\": True,\n}\n```\n\n## Usage\n\nTo edit the guide, the user needs to be an admin, or have the `Manage editor guide` 'change' value checked in their user group permissions.\n\n### Editing the guide\n\nTo edit the guide, from the left hand menu open settings \u003e then click 'Manage editor guide'. Edit your content and then save.\n\n![guide edit](screenshots/editing.png)\n\n#### Guide navigation menu\n\nIf 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'\n\n### Viewing the guide\n\nOnce logged in, a new menu icon towards the bottom of the left hand menu will be visible labeled as 'Editor guide':\n\n![guide view](screenshots/default.png)\n\n## Dependencies\n\nWagtail Guide requires `wagtail\u003e=5.2`\n\n## Contributing\n\nWe welcome contributions to this project, see [CONTRIBUTING.md](docs/CONTRIBUTING.md) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftorchbox%2Fwagtailguide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftorchbox%2Fwagtailguide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftorchbox%2Fwagtailguide/lists"}