6439b1e8a5
- add clarity that page links can also get auto-generated labels - add example of a reference link using a custom label - format with prettier |
||
|---|---|---|
| .circleci | ||
| .github | ||
| .tx | ||
| client | ||
| docs | ||
| etc | ||
| scripts | ||
| wagtail | ||
| .coveragerc | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .git-blame-ignore-revs | ||
| .gitignore | ||
| .nvmrc | ||
| .pre-commit-config.yaml | ||
| .prettierignore | ||
| .readthedocs.yml | ||
| .squash.yml | ||
| .stylelintignore | ||
| .stylelintrc.js | ||
| CHANGELOG.txt | ||
| CODE_OF_CONDUCT.md | ||
| codecov.yml | ||
| conftest.py | ||
| CONTRIBUTORS.rst | ||
| LICENSE | ||
| Makefile | ||
| MANIFEST.in | ||
| package-lock.json | ||
| package.json | ||
| prettier.config.js | ||
| README.md | ||
| runtests.py | ||
| SECURITY.md | ||
| setup.cfg | ||
| setup.py | ||
| SPONSORS.md | ||
| tailwind.config.js | ||
| tox.ini | ||
| tsconfig.json | ||
Wagtail is an open source content management system built on Django, with a strong community and commercial support. It's focused on user experience, and offers precise control for designers and developers.
Features
- A fast, attractive interface for authors
- Complete control over front-end design and structure
- Scales to millions of pages and thousands of editors
- Fast out of the box, cache-friendly when you need it
- Content API for 'headless' sites with de-coupled front-end
- Runs on a Raspberry Pi or a multi-datacenter cloud platform
- StreamField encourages flexible content without compromising structure
- Powerful, integrated search, using Elasticsearch or PostgreSQL
- Excellent support for images and embedded content
- Multi-site and multi-language ready
- Embraces and extends Django
Find out more at wagtail.org.
Getting started
Wagtail works with Python 3, on any platform.
To get started with Wagtail, run the following in a virtual environment:
pip install wagtail
wagtail start mysite
cd mysite
pip install -r requirements.txt
python manage.py migrate
python manage.py createsuperuser
python manage.py runserver
For detailed installation and setup docs, see docs.wagtail.org.
Who’s using it?
Wagtail is used by NASA, Google, Oxfam, the NHS, Mozilla, MIT, the Red Cross, Salesforce, NBC, BMW, and the US and UK governments. Add your own Wagtail site to madewithwagtail.org.
Documentation
docs.wagtail.org is the full reference for Wagtail, and includes guides for developers, designers and editors, alongside release notes and our roadmap.
Compatibility
(If you are reading this on GitHub, the details here may not be indicative of the current released version - please see Compatible Django / Python versions in the Wagtail documentation.)
Wagtail supports:
- Django 3.2.x and 4.0.x
- Python 3.7, 3.8, 3.9 and 3.10
- PostgreSQL, MySQL and SQLite as database backends
Previous versions of Wagtail additionally supported Python 2.7 and earlier Django versions.
Community Support
There is an active community of Wagtail users and developers responding to questions on Stack Overflow. When posting questions, please read Stack Overflow's advice on how to ask questions and remember to tag your question "wagtail".
For topics and discussions that do not fit Stack Overflow's question and answer format, we have a Slack workspace and a Wagtail Support mailing list. Please respect the time and effort of volunteers by not asking the same question in multiple places.
Our Github discussion boards are open for sharing ideas and plans for the Wagtail project.
We maintain a curated list of third party packages, articles and other resources at Awesome Wagtail.
Commercial Support
Wagtail is sponsored by Torchbox. If you need help implementing or hosting Wagtail, please contact us: hello@torchbox.com. See also madewithwagtail.org/developers/ for expert Wagtail developers around the world.
Security
We take the security of Wagtail, and related packages we maintain, seriously. If you have found a security issue with any of our projects please email us at security@wagtail.org so we can work together to find and patch the issue. We appreciate responsible disclosure with any security related issues, so please contact us first before creating a Github issue.
If you want to send an encrypted email (optional), the public key ID for security@wagtail.org is 0xbed227b4daf93ff9, and this public key is available from most commonly-used keyservers.
Release schedule
Feature releases of Wagtail are released every three months. Selected releases are designated as Long Term Support (LTS) releases, and will receive maintenance updates for an extended period to address any security and data-loss related issues. For dates of past and upcoming releases and support periods, see Release Schedule.
Nightly releases
To try out the latest features before a release, we also create builds from main every night. You can find instructions on how to install the latest nightly release at https://releases.wagtail.org/nightly/index.html
Contributing
If you're a Python or Django developer, fork the repo and get stuck in! We have several developer focused channels on the Slack workspace.
You might like to start by reviewing the contributing guidelines and checking issues with the good first issue label.
We also welcome translations for Wagtail's interface. Translation work should be submitted through Transifex.
License
Thanks
We thank the following organisations for their services used in Wagtail's development:
BrowserStack provides the project with free access to their live web-based browser testing tool, and automated Selenium cloud testing.
Squash provides the project with free test environments for reviewing pull requests.
Assistiv Labs provides the project with unlimited access to their remote testing with assistive technologies.
