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
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
new file mode 100644
index 0000000..6807318
--- /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