Design/Living style guide
A living style guide offers improved documentation of the visual appearance and behavior of a site.
MediaWiki currently has two style guides
- http://tools.wmflabs.org/styleguide/desktop/ for the mediawiki.UI modules in core since release 1.22
- https://livingstyleguide.wmflabs.org for the OOjs UI component library, typography, colors and iconography.
Starting with release 1.25, when you use OOjs UI components within MediaWiki, they use its MediaWiki theme which is very similar to mediawiki.UI.
Implementation[edit | edit source]
OOjs UI style guide[edit | edit source]
- Under active development, subject to change
In addition to per-component documentation, the guide will also have guidelines on typography, iconography, and how to compose elements.
mediawiki.UI style guide[edit | edit source]
A Makefile in core builds a static styleguide from the contents of files in resources/src/mediawiki.ui using kss-node. The generated HTML is published to http://tools.wmflabs.org/styleguide . (Continuous integration should rebuild this styleguide as needed at https://doc.wikimedia.org, phab:T58620.)
The downside of being standalone is you can't see how how styles behave with different skins and Beta features enabled. Gerrit change 95279 built a styleguide in MediaWiki, viewable at Special:StyleGuide