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/guide/components/alert.md | 4 +++- docs/guide/components/index.md | 4 ---- docs/guide/components/readme.md | 4 ++++ 3 files changed, 7 insertions(+), 5 deletions(-) delete mode 100644 docs/guide/components/index.md create mode 100644 docs/guide/components/readme.md (limited to 'docs/guide/components') diff --git a/docs/guide/components/alert.md b/docs/guide/components/alert.md index 768aa873..1ad965bd 100644 --- a/docs/guide/components/alert.md +++ b/docs/guide/components/alert.md @@ -3,7 +3,9 @@ An alert is an inline message that contains a short description that a user cann [Learn more about Bootstrap-vue alert options](https://bootstrap-vue.js.org/docs/components/alert) - +This is a warning message +This is an error message +This is an info message ```vue This is a warning message diff --git a/docs/guide/components/index.md b/docs/guide/components/index.md deleted file mode 100644 index f10a1317..00000000 --- a/docs/guide/components/index.md +++ /dev/null @@ -1,4 +0,0 @@ -# Overview -Vue components are the building blocks of the OpenBMC Web UI. It uses both Boostrap-Vue components, as well as custom components. Using these components assures consistency throughout the application. They also improve the developer experience and increase efficiency. Review the existing components before using HTML markup. If the feature you're working on includes a new layout pattern, rather than adding raw markup to the page, consider creating a component that other sections of the application can use as well. - -[Learn more about Vue components](https://vuejs.org/v2/guide/components.html) \ No newline at end of file diff --git a/docs/guide/components/readme.md b/docs/guide/components/readme.md new file mode 100644 index 00000000..f10a1317 --- /dev/null +++ b/docs/guide/components/readme.md @@ -0,0 +1,4 @@ +# Overview +Vue components are the building blocks of the OpenBMC Web UI. It uses both Boostrap-Vue components, as well as custom components. Using these components assures consistency throughout the application. They also improve the developer experience and increase efficiency. Review the existing components before using HTML markup. If the feature you're working on includes a new layout pattern, rather than adding raw markup to the page, consider creating a component that other sections of the application can use as well. + +[Learn more about Vue components](https://vuejs.org/v2/guide/components.html) \ No newline at end of file -- cgit v1.2.3