wagtail/docs
LB Johnston 8251072e6d Replace usage of innerHTML with textContent
- Stimulus CountController content is programatically generated but best to avoid writing HTML accidentally
- ChooserModel field required label should avoid risk of translations with HTML
- Image focal point chooser's label does not need to support HTML
- FieldBlock us using h util but this can be avoided by built in browser escaping when innerText is used
- focal-point-chooser gets value from its set up but we should avoid innerHTML if we can
2023-07-06 12:26:43 +10:00
..
_static Revamp more of the getting started tutorial 2023-06-30 14:49:15 +01:00
_templates Update Algolia DocSearch integration with new application and correct versioning setup 2023-03-10 15:57:17 +00:00
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 Move editor guide content to its own website 2022-10-28 10:16:32 +01:00
extending Docs - Align on client-side & fix Draftail typos 2023-07-03 19:18:44 +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 Replace usage of innerHTML with textContent 2023-07-06 12:26:43 +10:00
topics Documentation - Fix mMissing Menu Prefix in example (#10599) 2023-06-27 07:53:52 +10:00
Makefile Fix broken "make livehtml" command 2021-02-04 11:55:02 -08:00
README.md Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py Documentation - update package versions 2022-10-17 10:07:44 +01:00
favicon.ico add favicon to documentation 2018-03-08 12:24:13 +00:00
index.rst Move snippets.md docs to its own directory 2023-05-24 11:06:00 +01:00
logo.png
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

README.md

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.