summaryrefslogtreecommitdiff
path: root/www/wiki/docs/kss/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'www/wiki/docs/kss/README.txt')
-rw-r--r--www/wiki/docs/kss/README.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/www/wiki/docs/kss/README.txt b/www/wiki/docs/kss/README.txt
new file mode 100644
index 00000000..76cfb627
--- /dev/null
+++ b/www/wiki/docs/kss/README.txt
@@ -0,0 +1,21 @@
+The Makefile, package.json, scripts, styleguide-template, and
+mediawiki.ui/styleguide.md files and directories here and in
+resources/src/mediawiki.ui/ support the automatic generation
+of CSS documentation from the source LESS files using kss for
+node.js, https://github.com/kneath/kss
+
+To build and open in your web browser, run:
+
+MEDIAWIKI_LOAD_URL=mediawiki_hostname/w/load.php make kssopen
+
+For example,
+
+MEDIAWIKI_LOAD_URL=1.2.3.4/w/load.php make kssopen
+
+If MediaWiki is running on localhost, you can omit MEDIAWIKI_LOAD_URL.
+
+To rebuild without opening the web browser, run:
+
+MEDIAWIKI_LOAD_URL=mediawiki_hostname/w/load.php make
+
+When modifying styleGuideModules.txt, keep the list in strict alphabetical order (with no extra formatting), so CSS loads in the same order as ResourceLoader's addModuleStyles does; this can affect rendering.