mirror of
https://github.com/wagtail/wagtail.git
synced 2024-11-29 17:36:49 +01:00
11793f88c5
Most of the samples were already 4-space indented, but a few were using 2-space, which is both inconsistent and, when it happened with Python code samples, incompatible with PEP8.
21 lines
824 B
ReStructuredText
21 lines
824 B
ReStructuredText
.. _styleguide:
|
|
|
|
UI Styleguide
|
|
=============
|
|
|
|
Developers working on the Wagtail UI or creating new UI components may wish to test their work against our Styleguide, which is provided as the contrib module "wagtailstyleguide".
|
|
|
|
To install the styleguide module on your site, add it to the list of ``INSTALLED_APPS`` in your settings:
|
|
|
|
.. code-block:: python
|
|
|
|
INSTALLED_APPS = (
|
|
...
|
|
'wagtail.contrib.wagtailstyleguide',
|
|
...
|
|
)
|
|
|
|
At present the styleguide is static: new UI components must be added to it manually, and there are no hooks into it for other modules to use. We hope to support hooks in the future.
|
|
|
|
The styleguide doesn't currently provide examples of all the core interface components; notably the Page, Document, Image and Snippet chooser interfaces are not currently represented.
|