{"id":19617358,"url":"https://github.com/allcaps/wagtail-guide","last_synced_at":"2025-04-28T02:32:03.203Z","repository":{"id":41999155,"uuid":"462814076","full_name":"allcaps/wagtail-guide","owner":"allcaps","description":null,"archived":false,"fork":false,"pushed_at":"2023-05-31T18:07:52.000Z","size":23118,"stargazers_count":17,"open_issues_count":1,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-05T05:33:13.194Z","etag":null,"topics":[],"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/allcaps.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-23T16:21:04.000Z","updated_at":"2022-09-13T09:47:49.000Z","dependencies_parsed_at":"2024-11-11T11:03:37.195Z","dependency_job_id":"9269459c-7ef0-4e91-b34b-643c1e23a1ae","html_url":"https://github.com/allcaps/wagtail-guide","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allcaps%2Fwagtail-guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allcaps%2Fwagtail-guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allcaps%2Fwagtail-guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allcaps%2Fwagtail-guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/allcaps","download_url":"https://codeload.github.com/allcaps/wagtail-guide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251238201,"owners_count":21557416,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-11-11T11:03:26.656Z","updated_at":"2025-04-28T02:32:01.843Z","avatar_url":"https://github.com/allcaps.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Wagtail Guide\n\nA user guide for Wagtail powered sites, generating screenshots and [video recordings](https://www.youtube.com/watch?v=E3-kFY6jPPY).\n\n\u003e View the Wagtail Space US 2022 talk: [Wagtail Guide - Coen van der Kamp](https://www.youtube.com/watch?v=W0tL-5V5BWA)\n\nWagtail guide uses Pytest + Selenium + Markdown + MKDocs. \n\n1. **Pytest** runs tests\n2. **Selenium** drives a browser and takes screenshots\n3. Wagtail Guide **MarkDownFactory** generates Markdown files\n4. **MKDocs** renders the documentation (optional)\n\n\n## Prerequisites \n\n### Chrome Driver\n\nChrome Driver on OSX (foreground mode):\n\n    brew install --cask chromedriver\n\nMove ChromeDriver out of quarantine:\n\n    xattr -d com.apple.quarantine /opt/homebrew/bin/chromedriver\n    spctl --add --label 'Approved' /opt/homebrew/bin/chromedriver\n\nIf `chromedriver` isn't on your path, set `SELENIUM_CHROMEDRIVER_EXECUTABLE_PATH`.\n\nIf you don't like to install the Chrome Driver to your system, use Docker. \nThis will execute in headless mode. Not suitable for development.\n\nApple Silicon:\n\n    docker run -d -p 4444:4444 --shm-size=\"2g\" seleniarm/standalone-chromium\n\nIntel Silicon:\n\n    docker run -d -p 4444:4444 --shm-size=2g selenium/standalone-chrome\n\n### FFMPEG (optional)\n\nIf you'd like to output video:\n\n    brew install ffmpeg\n\n### TTS (optional)\n\nIf you like to output video. Text to speech:\n\n    docker run -it -p 5002:5002 synesthesiam/mozillatts:en\n\n## Install\n\n    pip install git+https://github.com/allcaps/wagtail-guide#egg=wagtail_guide\n\n    INSTALLED_APPS = [\n        \"wagtail_guide\",\n        ...\n    ]\n\n## Usage\n\nForeground mode (chromedriver required)\n\n    python manage.py buildguide\n\nHeadless mode (Selenium Docker required)\n\n    SELENIUM_REMOTE_URL=YOUR_HOST_IP HEADLESS=1 python manage.py buildguide\n\nTo convert markdown to documentation, I'd suggest using MkDocs. In your project root:\n\n    pip install mkdocs\n    mkdocs new .\n\nWrite to mkdocs.yml. Ref: https://www.mkdocs.org/getting-started/#adding-pages\n\n    site_name: Example.com User Guide\n    nav:\n        - Home: index.md\n\nServe the docs:\n\n    mkdocs serve\n\n\n## Customise the documentation generation\n\nWagtail guide comes with Markdown, reStructuredText and video support.\n\nThe `WAGTAIL_GUIDE_CHAPTERS` are called in order with `live_server` and `driver` as arguments. Default:\n\n    WAGTAIL_GUIDE_CHAPTERS = [\n            \"wagtail_guide.markdown.getting_started\",\n            \"wagtail_guide.markdown.demo\",\n    ]\n\nOther chapters:\n\n* `wagtail_guide.video.getting_started`\n\nExtend and/or customise the documentation generation. Add your callables to `WAGTAIL_GUIDE_CHAPTERS`.\n\n# Audio\n\nAudio by [Kamara](https://www.kamara.nl/)\n\n# Big thanks to\n\n- https://github.com/django/django\n- https://github.com/wagtail/wagtail\n- https://github.com/SeleniumHQ/selenium\n- https://github.com/baijum/selenium-python\n- https://github.com/pytest-dev/pytest\n- https://github.com/pytest-dev/pytest-django\n- https://github.com/mozilla/TTS\n- https://github.com/quodlibet/mutagen\n- https://github.com/FFmpeg/FFmpeg\n- https://github.com/Zulko/moviepy\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallcaps%2Fwagtail-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fallcaps%2Fwagtail-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallcaps%2Fwagtail-guide/lists"}