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 /docs/.vuepress/config.js | |
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 '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 |