0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-25 13:10:14 +01:00
wagtail/docs
LB Johnston 04d1e8162b Migrate header search to a Stimulus controller (w-swap)
- Removes the jQuery slide animation so content will be instantly replaced
- Removes the autofocus behaviour on the search fields as this is not helpful for screen readers / keyboard control
- Includes support for `window.header` if provided alongside dynamic adding of data-* attributes if not included
- Base implementation for #9950
- Co-authored-by: sag᠎e <laymonage@gmail.com>
2023-07-06 20:10:31 +10:00
..
_static Revamp more of the getting started tutorial 2023-06-30 14:49:15 +01:00
_templates
advanced_topics Docs - Align on client-side & fix Draftail typos 2023-07-03 19:18:44 +10:00
contributing Convert the CONTRIBUTORS file to Markdown 2023-06-28 20:50:12 +10:00
editor_manual
extending Implement new Draftail customisation APIs 2023-07-06 13:14:54 +10:00
getting_started Switch the tutorial snippets example to be more understandable #10609 (#10624) 2023-07-03 16:54:49 +01:00
public Move security.txt to wagtail.org (#9751) 2023-04-21 18:01:09 +01:00
reference Refactor "More" listing dropdowns to new dropdown component 2023-06-26 13:55:08 +01:00
releases Migrate header search to a Stimulus controller (w-swap) 2023-07-06 20:10:31 +10:00
topics Documentation - Fix mMissing Menu Prefix in example (#10599) 2023-06-27 07:53:52 +10:00
autobuild.sh
conf.py
favicon.ico
index.rst Move snippets.md docs to its own directory 2023-05-24 11:06:00 +01:00
logo.png
Makefile
README.md Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00
spelling_wordlist.txt Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00
support.md Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00

Wagtail docs

These are Sphinx docs, automatically built at https://docs.wagtail.org when the main branch is committed to GitHub. To build them locally, install Wagtail's development requirements (in the root Wagtail directory):

pip install -e .[testing,docs]

To build the documentation for browsing, from this directory run:

make html

then open _build/html/index.html in a browser.

To rebuild automatically while editing the documentation, from this directory run:

sphinx-autobuild . _build

The online MyST playground at Curvenote or the MyST-Markdown VS Code Extension are helpful tools for working with the MyST syntax.