Improvements to KSS CSS documentation generation
authorS Page <spage@wikimedia.org>
Sat, 21 Dec 2013 10:06:21 +0000 (02:06 -0800)
committerSpage <spage@wikimedia.org>
Sat, 21 Dec 2013 10:12:29 +0000 (10:12 +0000)
Avoid npm warnings.
Makefile fixes: it's not a bash script, kss is default target, quieter
output.

Change-Id: Ia7b862b6bef95c7735a42c1b6f70625283e915ab

resources/Makefile
resources/README.txt [new file with mode: 0644]
resources/package.json

index 36b75ae..4de5c2f 100644 (file)
@@ -1,12 +1,9 @@
-#!/bin/bash
-MW_INSTALL_PATH ?= ../..
+kss: nodecheck
+# FIXME: Use more up-to-date Ruby version
+       @node_modules/.bin/kss-node mediawiki.ui mediawiki.ui/docs -l mediawiki.ui/vector.less -t styleguide-template
+       @echo Opening the generated style guide...
+       @command -v xdg-open >/dev/null 2>&1 || { open ${PWD}/mediawiki.ui/docs/index.html; exit 1; }
+       @xdg-open ${PWD}/mediawiki.ui/docs/index.html
 
 nodecheck:
        @scripts/nodecheck.sh
-
-kss: nodecheck
-       # FIXME: Use more up to date Ruby version
-       kss-node mediawiki.ui mediawiki.ui/docs -l mediawiki.ui/vector.less -t styleguide-template
-       # Open the resulting style guide (try using xdg-open or open):
-       command -v xdg-open >/dev/null 2>&1 || { open ${PWD}/mediawiki.ui/docs/index.html; exit 1; }
-       xdg-open ${PWD}/mediawiki.ui/docs/index.html
diff --git a/resources/README.txt b/resources/README.txt
new file mode 100644 (file)
index 0000000..d91bf2a
--- /dev/null
@@ -0,0 +1,4 @@
+The Makefile, package.json, scripts, styleguide-template, and
+mediawiki.ui/styleguide.md files and directories in here support the automatic
+generation of CSS documentation from the source LESS files using kss for
+node.js, https://github.com/kneath/kss
index c34ff4f..a1722b5 100644 (file)
@@ -4,5 +4,10 @@
        "version": "0.0.1",
        "dependencies": {
                "kss": ">=0.3.6"
+       },
+       "repository" : {
+               "type" : "git",
+               "url" : "https://gerrit.wikimedia.org/r/p/mediawiki/core.git"
        }
+
 }