From aae4312c3c535253b2d5db7a75503f0237ae423e Mon Sep 17 00:00:00 2001 From: Derick Montague Date: Fri, 3 Jan 2020 08:36:20 -0600 Subject: 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 Change-Id: I2fdae06d53c298d45f7a638e8875717a47050dbf --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 87b1ce5c..2f4cf0fd 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3