aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-css-plugin/src
diff options
context:
space:
mode:
authorElena Vilchik2019-12-27 16:13:56 +0100
committerquentin-jaquier-sonarsource2019-12-27 16:13:56 +0100
commit8728086a4c0f10e035d49379a5b386e26083994f (patch)
treeaf13ed8e69bd6c89ff5cdd2c5a0ffbc29359a039 /sonar-css-plugin/src
parent2bbe2243f0a393dd3c9884dca5560f583a843f88 (diff)
downloadsonar-css-8728086a4c0f10e035d49379a5b386e26083994f.tar.bz2
Add analyzer documentation (#233)
Diffstat (limited to 'sonar-css-plugin/src')
-rw-r--r--sonar-css-plugin/src/main/resources/static/documentation.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/sonar-css-plugin/src/main/resources/static/documentation.md b/sonar-css-plugin/src/main/resources/static/documentation.md
new file mode 100644
index 0000000..d1dfd6b
--- /dev/null
+++ b/sonar-css-plugin/src/main/resources/static/documentation.md
@@ -0,0 +1,25 @@
+---
+title: CSS
+key: css
+---
+
+<!-- static -->
+<!-- update_center:cssfamily -->
+<!-- /static -->
+
+
+## Prerequisites
+In order to analyze CSS code, you need to have Node.js >= 8 installed on the machine running the scan. Set property `sonar.nodejs.executable` to an absolute path to Node.js executable, if standard `node` is not available.
+
+If you have a community plugin that handles CSS installed on your SonarQube instance it will conflict with SonarCSS, so it should be removed.
+
+## Language-Specific Properties
+
+Discover and update the CSS-specific [properties](/analysis/analysis-parameters/) in: <!-- sonarcloud -->Project <!-- /sonarcloud -->**[Administration > General Settings > CSS](/#sonarqube-admin#/admin/settings?category=css)**
+
+## Supported Languages
+* CSS, SCSS, Less
+* Also 'style' inside PHP, HTML and VueJS files
+
+## Related Pages
+* [Importing External Issues](/analysis/external-issues/) (StyleLint.io)