Add coding guidelines and component documentation
Resubmitting after reverted–original commit here
https://gerrit.openbmc-project.xyz/c/openbmc/webui-vue/+/28760
- Update README to include instructions on documentation development
- Update vue and vue-template-compiler to be compatible with vuepress
Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: I72049a5888ef6bea6621d0b7948f57a8e4177666
diff --git a/package.json b/package.json
index 2cefe6f..188545d 100644
--- a/package.json
+++ b/package.json
@@ -7,7 +7,9 @@
"serve": "vue-cli-service serve",
"build": "vue-cli-service build",
"test:unit": "vue-cli-service test:unit",
- "lint": "vue-cli-service lint"
+ "lint": "vue-cli-service lint",
+ "docs:serve": "vuepress dev docs",
+ "docs:build": "vuepress build docs"
},
"dependencies": {
"@carbon/icons-vue": "10.6.1",
@@ -16,8 +18,8 @@
"bootstrap-vue": "2.1.0",
"core-js": "3.3.2",
"js-cookie": "^2.2.1",
- "vue": "2.6.10",
- "vue-date-fns": "^1.1.0",
+ "vue": "2.6.11",
+ "vue-date-fns": "1.1.0",
"vue-router": "3.1.3",
"vuelidate": "^0.7.4",
"vuex": "3.0.1"
@@ -40,7 +42,8 @@
"node-sass": "4.13.1",
"prettier": "1.18.2",
"sass-loader": "8.0.0",
- "vue-template-compiler": "2.6.10"
+ "vue-template-compiler": "2.6.11",
+ "vuepress": "^1.2.0"
},
"gitHooks": {
"pre-commit": "lint-staged"