From b115aea1eab526971983369986e2d2a56e17ff15 Mon Sep 17 00:00:00 2001 From: Derick Montague Date: Fri, 17 Apr 2020 16:49:15 -0500 Subject: 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 Change-Id: If5588f88a3d75761cc47e85a3fb0a582b31d373c --- docs/.vuepress/styles/_bmc-overrides.scss | 0 docs/.vuepress/styles/_bmc.scss | 2 ++ docs/.vuepress/styles/_bootstrap-vue.scss | 1 + docs/.vuepress/styles/_bootstrap.scss | 34 +++++++++++++++++++++++++++++++ docs/.vuepress/styles/_index.scss | 5 +++++ 5 files changed, 42 insertions(+) create mode 100644 docs/.vuepress/styles/_bmc-overrides.scss create mode 100644 docs/.vuepress/styles/_bmc.scss create mode 100644 docs/.vuepress/styles/_bootstrap-vue.scss create mode 100644 docs/.vuepress/styles/_bootstrap.scss create mode 100644 docs/.vuepress/styles/_index.scss (limited to 'docs/.vuepress/styles') diff --git a/docs/.vuepress/styles/_bmc-overrides.scss b/docs/.vuepress/styles/_bmc-overrides.scss new file mode 100644 index 00000000..e69de29b 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"; -- cgit v1.2.3