diff options
author | Derick Montague <derick.montague@ibm.com> | 2020-04-18 00:49:15 +0300 |
---|---|---|
committer | Derick Montague <derick.montague@ibm.com> | 2020-05-15 00:47:04 +0300 |
commit | b115aea1eab526971983369986e2d2a56e17ff15 (patch) | |
tree | 29e3298a5208306a5dae9b55cf1075844ab348a0 /docs/.vuepress | |
parent | 20d8c1867088f47cd970e7cf76a0f8c0c723b6f7 (diff) | |
download | webui-vue-b115aea1eab526971983369986e2d2a56e17ff15.tar.xz |
Add themes documentation
- Renamed all index.md to readme.md to make consuming the documentation
from the Github repo easier. VuePress treats index.md and readme.md the
same way when building the static pages.
- Added theme section overview documentation
- Added how to customize documentation
- Added custom style imports to support OpenBMC Web UI component
documentation to remove Bootstrap framework base styles that conflict
with the Vuepress theme
- Found occurrences of the word Sass in upper-case and changed to use
sentence case.
Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: If5588f88a3d75761cc47e85a3fb0a582b31d373c
Diffstat (limited to 'docs/.vuepress')
-rw-r--r-- | docs/.vuepress/components/BmcAlerts.vue | 14 | ||||
-rw-r--r-- | docs/.vuepress/config.js | 2 | ||||
-rw-r--r-- | docs/.vuepress/enhanceApp.js | 2 | ||||
-rw-r--r-- | docs/.vuepress/styles/_bmc-overrides.scss | 0 | ||||
-rw-r--r-- | docs/.vuepress/styles/_bmc.scss | 2 | ||||
-rw-r--r-- | docs/.vuepress/styles/_bootstrap-vue.scss | 1 | ||||
-rw-r--r-- | docs/.vuepress/styles/_bootstrap.scss | 34 | ||||
-rw-r--r-- | docs/.vuepress/styles/_index.scss | 5 |
8 files changed, 44 insertions, 16 deletions
diff --git a/docs/.vuepress/components/BmcAlerts.vue b/docs/.vuepress/components/BmcAlerts.vue deleted file mode 100644 index 60440644..00000000 --- a/docs/.vuepress/components/BmcAlerts.vue +++ /dev/null @@ -1,14 +0,0 @@ -<template> - <div> - <alert show variant="warning">This is a warning message</alert> - <alert show variant="danger">This is an error message</alert> - <alert show variant="info">This is an info message</alert> - </div> -</template> - -<script> - -export default { - name: 'BmcAlerts', -} -</script>
\ No newline at end of file diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 8f94ff5b..dd112e61 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -51,7 +51,7 @@ module.exports = { ] } ], - "/themes/": [""] + "/themes/": ["", "customize"] }, } };
\ No newline at end of file diff --git a/docs/.vuepress/enhanceApp.js b/docs/.vuepress/enhanceApp.js index 72fd24d7..9a3b2b64 100644 --- a/docs/.vuepress/enhanceApp.js +++ b/docs/.vuepress/enhanceApp.js @@ -1,5 +1,5 @@ -import "../../src/assets/styles/_obmc-custom.scss"; +import "./styles/_index.scss"; import Alert from "../../src/components/Global/Alert"; import BVToastMixin from "../../src/components/Mixins/BVToastMixin"; diff --git a/docs/.vuepress/styles/_bmc-overrides.scss b/docs/.vuepress/styles/_bmc-overrides.scss new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/docs/.vuepress/styles/_bmc-overrides.scss diff --git a/docs/.vuepress/styles/_bmc.scss b/docs/.vuepress/styles/_bmc.scss new file mode 100644 index 00000000..09d1f01d --- /dev/null +++ b/docs/.vuepress/styles/_bmc.scss @@ -0,0 +1,2 @@ +@import "src/assets/styles/bmc/helpers"; +@import "src/assets/styles/bmc/base";
\ No newline at end of file diff --git a/docs/.vuepress/styles/_bootstrap-vue.scss b/docs/.vuepress/styles/_bootstrap-vue.scss new file mode 100644 index 00000000..51410394 --- /dev/null +++ b/docs/.vuepress/styles/_bootstrap-vue.scss @@ -0,0 +1 @@ +@import "src/assets/styles/vendor/bootstrap-vue/index";
\ No newline at end of file diff --git a/docs/.vuepress/styles/_bootstrap.scss b/docs/.vuepress/styles/_bootstrap.scss new file mode 100644 index 00000000..31a5f34d --- /dev/null +++ b/docs/.vuepress/styles/_bootstrap.scss @@ -0,0 +1,34 @@ +// Removing reboot and type imports to resolve +// conflicts with vuepress styles +@import "~bootstrap/scss/functions"; +@import "~bootstrap/scss/variables"; +@import "~bootstrap/scss/mixins"; +@import "~bootstrap/scss/root"; +@import "~bootstrap/scss/alert"; +@import "~bootstrap/scss/badge"; +@import "~bootstrap/scss/breadcrumb"; +@import "~bootstrap/scss/button-group"; +@import "~bootstrap/scss/buttons"; +@import "~bootstrap/scss/card"; +@import "~bootstrap/scss/close"; +@import "~bootstrap/scss/code"; +@import "~bootstrap/scss/custom-forms"; +@import "~bootstrap/scss/dropdown"; +@import "~bootstrap/scss/forms"; +@import "~bootstrap/scss/grid"; +@import "~bootstrap/scss/images"; +@import "~bootstrap/scss/input-group"; +@import "~bootstrap/scss/list-group"; +@import "~bootstrap/scss/media"; +@import "~bootstrap/scss/modal"; +@import "~bootstrap/scss/nav"; +@import "~bootstrap/scss/navbar"; +@import "~bootstrap/scss/pagination"; +@import "~bootstrap/scss/popover"; +@import "~bootstrap/scss/progress"; +@import "~bootstrap/scss/spinners"; +@import "~bootstrap/scss/tables"; +@import "~bootstrap/scss/toasts"; +@import "~bootstrap/scss/tooltip"; +@import "~bootstrap/scss/transitions"; +@import "~bootstrap/scss/utilities";
\ No newline at end of file diff --git a/docs/.vuepress/styles/_index.scss b/docs/.vuepress/styles/_index.scss new file mode 100644 index 00000000..8587715a --- /dev/null +++ b/docs/.vuepress/styles/_index.scss @@ -0,0 +1,5 @@ + +@import "./bmc"; +@import "./bootstrap"; +@import "./bootstrap-vue"; +@import "./bmc-overrides"; |