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 /docs/.vuepress/config.js | |
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 'docs/.vuepress/config.js')
-rw-r--r-- | docs/.vuepress/config.js | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js new file mode 100644 index 00000000..68073188 --- /dev/null +++ b/docs/.vuepress/config.js @@ -0,0 +1,51 @@ +module.exports = { + base: "/webui-vue/", + title: "OpenBMC Web UI Style Guide", + description: + "Guidance on code style and development for the OpenBMC browser-based UI", + smoothScroll: true, + themeConfig: { + nav: [ + { + text: "Guide", + link: "/guide/getting-started" + }, + { + text: "Themes", + link: "/themes/" + }, + { + text: "Github", + link: "https://github.com/openbmc/webui-vue" + } + ], + sidebarDepth: 1, + sidebar: { + "/guide/": [ + "getting-started", + { + title: "Coding Standards", + children: [ + "/guide/coding-standards/", + ["/guide/coding-standards/accessibility", "Accessibility"], + ["/guide/coding-standards/sass", "SASS"], + ["/guide/coding-standards/javascript", "JavaScript"] + ] + }, + { + title: "Guidelines", + children: [ + "/guide/guidelines/", + "/guide/guidelines/colors", + "/guide/guidelines/typography" + ] + }, + { + title: "Components", + children: ["/guide/components/", "/guide/components/page-section"] + } + ] + }, + "/themes/": [""] + } + };
\ No newline at end of file |