wagtail/docs/contributing/styleguide.md

(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:

```python
INSTALLED_APPS = (
    # ...
    'wagtail.contrib.styleguide',
    # ...
)
```

This will add a 'Styleguide' item to the Settings menu in the admin.

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.
documentation - convert contributing files from rst to markdown 2022-06-30 20:27:24 +00:00			`(styleguide)=`
Move wagtailsettings into contrib module The `wagtailsettings` module is useful enough that it should be included in the Wagtail contrib section, to make it available to all Wagtail developers. All the code has been given a once-over to make sure it is nice and polished before being copied in. As such, this is not a direct copy of the `wagtailsettings` module. It should be backwards compatible though, excepting the new location. It has been moved to `wagtail.contrib.settings`, following the naming scheme set out in #1504. Documentation has been concatenated in to a single page, and added to the contrib reference section. 2015-09-30 05:28:33 +00:00
documentation - convert contributing files from rst to markdown 2022-06-30 20:27:24 +00:00			`# UI Styleguide`
moved styleguide to own page. renamed trying wagtail to demo site 2015-05-14 13:02:06 +00:00
			`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".`

documentation - convert contributing files from rst to markdown 2022-06-30 20:27:24 +00:00			To install the styleguide module on your site, add it to the list of `INSTALLED_APPS` in your settings:
moved styleguide to own page. renamed trying wagtail to demo site 2015-05-14 13:02:06 +00:00
documentation - convert contributing files from rst to markdown 2022-06-30 20:27:24 +00:00			```python
			`INSTALLED_APPS = (`
			`# ...`
			`'wagtail.contrib.styleguide',`
			`# ...`
			`)`
			```
moved styleguide to own page. renamed trying wagtail to demo site 2015-05-14 13:02:06 +00:00
Mention where to access the styleguide - fixes #3009 2016-09-19 12:49:52 +00:00			`This will add a 'Styleguide' item to the Settings menu in the admin.`

moved styleguide to own page. renamed trying wagtail to demo site 2015-05-14 13:02:06 +00:00			`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.`

Move wagtailsettings into contrib module The `wagtailsettings` module is useful enough that it should be included in the Wagtail contrib section, to make it available to all Wagtail developers. All the code has been given a once-over to make sure it is nice and polished before being copied in. As such, this is not a direct copy of the `wagtailsettings` module. It should be backwards compatible though, excepting the new location. It has been moved to `wagtail.contrib.settings`, following the naming scheme set out in #1504. Documentation has been concatenated in to a single page, and added to the contrib reference section. 2015-09-30 05:28:33 +00:00			`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.`