summaryrefslogtreecommitdiff
path: root/docs/.vuepress/enhanceApp.js
AgeCommit message (Collapse)AuthorFilesLines
2020-11-16Update VuePress configurationYoshie Muranaka1-24/+0
We are moving away from importing application components directly into the VuePress docs. We will document code snippets and add screenshots as a visual example. This commit removes all code and configurations that supported importing dynamic components into VuePress and added images in place of a working component example on the page. Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com> Change-Id: I9a75c5d51de8b6d941e4df7ae977d78c043d36e1
2020-11-07Add documentation for table componentYoshie Muranaka1-0/+2
Adds Table documentation page under Components section with an example of how to create a basic table. Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com> Change-Id: I9033fae662bd46d301edfb02d8a5c108e05017c6
2020-11-05Fix icon color in documentationDerick Montague1-0/+2
- Add StatusIcon to ehnaceApp and use the component imported into the the documentation's component/app-imports directory to resolve fill rendering bug in the Alert component - Remove the scoped attribute to make the changes work for alerts in documentation - Update StatusIcon component to match changes to application component Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I4090d58f78a1d10d9745ee592424ca0c0c91c610
2020-10-20Fix documentation render bugDerick Montague1-2/+0
Using the i18n module in the BVToastMixin file caused an issue with VuePress that resulted in the static files not being created and the documentation rendering as a blank page. - Removed the import of the BVToastMixin - Copied BVToastMixin to docs components and removed i18n - Copied the StatusIcon to docs components to so icons will render with the correct fill color in the toast notifications GitHub Issue: https://github.com/openbmc/webui-vue/issues/40 Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: Ie479df17d529ad2803c41e7442801e13601a0a02
2020-05-15Add themes documentationDerick Montague1-1/+1
- 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
2020-03-20Add alert message component and documentationDerick Montague1-1/+4
- Add custom alert component to simplify the use of custom alerts - Add documentation for using the custom alert - Update the login error alert to use the alert component instead of the Bootstrap-vue component. - Register alert component in enhanceApp - Replace Sass variables used in the StatusIcon component style block to use the Boostrap theme-color and gray Sass functions so the colors can be used in the Vuepress documentation custom components Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: Ibd93402c919a42bd5c24cc9e7c6c8fc6f17a4db4
2020-03-20Add toast component documentationDerick Montague1-1/+10
- Add documentation that describes when and how to use a toast message with code snippets - Add an informational toast method in the BVToastMixin - Add BVToastMixin to enhaceApp to register mixin globally. Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I89bf2aa8b3fdb9294354a80c98ccf692b6e3615a
2020-03-20Add buttons documentationDerick Montague1-0/+10
- Add documentation for how to use buttons - Update markup and CSS rulesets to support icons on the left or the right of text Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: Ic897f416e85824287360bc7ef5dc47c402d64eba
2020-03-13Revert "Add alert message component and documentation"Derick Montague1-10/+0
This reverts commit 71650fff20c0ad29eb05d770736386863324b64e. Reason for revert: Found an issue with Sass loader when compiling docs that needs to be addressed. Change-Id: Icdd1243665f60849bfb341594452687fcdaeebe2
2020-03-12Add alert message component and documentationDerick Montague1-0/+10
- Add custom alert component to simplify the use of custom alerts - Add documentation for using the custom alert - Update the login error alert to use the alert component instead of the Bootstrap-vue component. - Add the enhanceApp and bmcAppPlugin to extend vuepress to use both the BMC custom and Boostrap-Vue components along with the custom styles Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I5c0b696ca47ddba0df18041d6c5ee7509bf23572
generated by cgit v1.2.3 (git 2.39.0) at 2024-07-09 14:07:22 +0300