diff options
| author | Derick Montague <derick.montague@ibm.com> | 2020-01-03 17:36:20 +0300 |
|---|---|---|
| committer | Yoshie Muranaka <yoshiemuranaka@gmail.com> | 2020-01-29 01:18:05 +0300 |
| commit | aae4312c3c535253b2d5db7a75503f0237ae423e (patch) | |
| tree | 83967ba91a1ff7d2f0909ce08029f2c2c7425c68 /README.md | |
| parent | 996d2d57be172fd36952ec7d679e411565cac013 (diff) | |
| download | webui-vue-aae4312c3c535253b2d5db7a75503f0237ae423e.tar.xz | |
Add coding guidelines and component documentation
- Add deploy script to create and deploy dist file to gh-pages branch
- Update README to include instructions on documentation development
and deployment
- Update vue and vue-template-compiler to be compatible with vuepress
- Set vue-date-fns to use specific version
- Add shell pages to be completed later
Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: I2fdae06d53c298d45f7a638e8875717a47050dbf
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 15 insertions, 0 deletions
@@ -60,3 +60,18 @@ 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/). + +### Development +1. `Run npm docs:dev` +1. Open browser and go to `http://localost:8080/` + +### Deployment +1. Merge any pull requests +1. Run `./depoly-docs.sh`
\ No newline at end of file |