diff options
| author | Derick Montague <derick.montague@ibm.com> | 2020-01-03 17:36:20 +0300 |
|---|---|---|
| committer | Derick Montague <derick.montague@ibm.com> | 2020-02-08 00:43:30 +0300 |
| commit | 365bce5f93f85408cd1b6393e69342e55a0a25ee (patch) | |
| tree | 9203b794b4f12bc0b0b233bd54f4ed327558093b /README.md | |
| parent | c65350fb4d63f3b6610264c814ec70a0362570cf (diff) | |
| download | webui-vue-365bce5f93f85408cd1b6393e69342e55a0a25ee.tar.xz | |
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
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
@@ -60,3 +60,14 @@ npm run test:unit ``` npm run lint ``` + +### Customize configuration + +See [Configuration Reference](https://cli.vuejs.org/config/). + +## Documentation +The documentation for coding standards and components is located in the `docs` directory. It is created using the [VuePress](https://vuepress.vuejs.org/) static site generator. Information about how to write documentation can be found on the [VuePress website](https://vuepress.vuejs.org/). + +### Running Locally +1. `Run npm docs:dev` +1. Open browser and go to `http://localost:8080/` |