From 2e8e33853231b34205f4a198930f617d2a664745 Mon Sep 17 00:00:00 2001 From: Jeremy Wilken Date: Thu, 6 Aug 2020 11:57:16 -0500 Subject: [PATCH] docs: clean up formatting and layout details Signed-off-by: Jeremy Wilken --- apps/website/.gitignore | 3 +- apps/website/.markdownlint.json | 8 + apps/website/.vuepress/config.js | 3 +- .../public/demos/button/icon-css.html | 12 +- .../public/demos/button/types-css.html | 6 - .../public/demos/card/clickable-css.html | 6 - .../public/demos/card/dropdown-css.html | 2 +- .../public/demos/checkbox/basic-css.html | 8 +- .../public/demos/checkbox/disabled-css.html | 33 +- .../public/demos/checkbox/helper-css.html | 12 +- .../demos/checkbox/indeterminate-css.html | 6 +- .../public/demos/checkbox/inline-css.html | 12 +- .../.vuepress/public/demos/header/types.html | 4 +- .../public/demos/login/login-css.html | 2 +- .../public/demos/radio/basic-css.html | 8 +- .../public/demos/radio/disabled-css.html | 12 +- .../public/demos/radio/helper-css.html | 12 +- .../public/demos/radio/inline-css.html | 12 +- .../public/demos/range/basic-css.html | 2 +- .../public/demos/range/disabled-css.html | 17 +- .../public/demos/range/helper-css.html | 17 +- .../.vuepress/theme/components/Home.vue | 6 +- .../.vuepress/theme/components/NavToc.vue | 26 + .../.vuepress/theme/components/Sidebar.vue | 7 +- apps/website/.vuepress/theme/core.js | 4 + .../theme/global-components/ClrImage.vue | 2 +- .../theme/global-components/DocDemo.vue | 7 +- .../website/.vuepress/theme/styles/index.scss | 1 - .../.vuepress/theme/styles/overrides.scss | 63 + apps/website/components/accordion/README.md | 2 + apps/website/components/alert/README.md | 10 +- .../website/components/button-group/README.md | 10 +- apps/website/components/button/README.md | 40 +- apps/website/components/button/api.md | 4 +- apps/website/components/card/README.md | 52 +- apps/website/components/card/_basic.html | 21 - apps/website/components/card/demo.md.orig | 1122 ----------------- apps/website/components/checkbox/README.md | 12 +- apps/website/components/datagrid/README.md | 4 +- apps/website/components/datagrid/api.md | 2 +- apps/website/components/date-picker/README.md | 14 +- apps/website/components/form/README.md | 20 +- apps/website/components/form/api.md | 2 - apps/website/components/header/README.md | 16 +- apps/website/components/input/README.md | 6 +- apps/website/components/label/README.md | 4 - apps/website/components/label/api.md | 8 - apps/website/components/login/README.md | 2 +- apps/website/components/modal/README.md | 18 +- apps/website/components/password/README.md | 4 +- .../website/components/progress-bar/README.md | 8 - apps/website/components/radio/README.md | 31 +- apps/website/components/radio/api.md | 11 - apps/website/components/range/README.md | 10 +- apps/website/components/range/api.md | 11 - apps/website/components/select/README.md | 2 +- apps/website/components/sidenav/README.md | 2 +- apps/website/components/signpost/README.md | 10 +- .../components/signpost/basic-css.html | 1 - .../website/components/signpost/basic-ng.html | 1 - apps/website/components/spinner/README.md | 8 +- apps/website/components/stack-view/README.md | 16 +- apps/website/components/stepper/README.md | 4 + apps/website/components/tab/api.md | 6 +- apps/website/components/table/README.md | 2 +- apps/website/components/textarea/README.md | 6 +- apps/website/components/tooltip/README.md | 45 +- apps/website/components/tree-view/README.md | 21 +- apps/website/foundation/README.md | 2 - apps/website/foundation/app-layout/README.md | 82 +- apps/website/foundation/color/README.md | 8 +- apps/website/foundation/themes/README.md | 40 +- apps/website/foundation/typography/README.md | 14 +- apps/website/get-started/design.md | 23 +- apps/website/package.json | 4 +- docs/WEBSITE.md | 15 + package.json | 3 +- scripts/update-license.js | 4 +- yarn.lock | 89 +- 79 files changed, 594 insertions(+), 1571 deletions(-) create mode 100644 apps/website/.markdownlint.json delete mode 100644 apps/website/components/card/_basic.html delete mode 100644 apps/website/components/card/demo.md.orig delete mode 100644 apps/website/components/label/api.md delete mode 100644 apps/website/components/signpost/basic-css.html delete mode 100644 apps/website/components/signpost/basic-ng.html create mode 100644 docs/WEBSITE.md diff --git a/apps/website/.gitignore b/apps/website/.gitignore index c9fb9f1e69..a331867989 100644 --- a/apps/website/.gitignore +++ b/apps/website/.gitignore @@ -1,3 +1,4 @@ api/ dist/ -node_modules/ \ No newline at end of file +node_modules/ +.vuepress/public/images diff --git a/apps/website/.markdownlint.json b/apps/website/.markdownlint.json new file mode 100644 index 0000000000..734be4c03a --- /dev/null +++ b/apps/website/.markdownlint.json @@ -0,0 +1,8 @@ +{ + "default": true, + "line-length": false, + "MD024": false, + "MD036": false, + "no-trailing-punctuation": false, + "no-inline-html": false +} diff --git a/apps/website/.vuepress/config.js b/apps/website/.vuepress/config.js index f0dc367850..7c61a60fd1 100644 --- a/apps/website/.vuepress/config.js +++ b/apps/website/.vuepress/config.js @@ -125,8 +125,7 @@ module.exports = { '@clr/core/textarea': path.resolve('../../dist/core/textarea'), '@clr/core/time': path.resolve('../../dist/core/time'), '@clr/core/toggle': path.resolve('../../dist/core/toggle'), - '@clr/icons': path.resolve('../../dist/clr-icons'), - '@clr/icons/shapes/all-shapes': path.resolve('../../dist/clr-icons/shapes/all-shapes.min'), + // @TODO Would like to be able to remove these 'ramda': path.resolve('../../packages/core/node_modules/ramda'), 'ramda/es/anyPass': path.resolve('../../packages/core/node_modules/ramda/es/anyPass.js'), 'ramda/es/equals': path.resolve('../../packages/core/node_modules/ramda/es/equals.js'), diff --git a/apps/website/.vuepress/public/demos/button/icon-css.html b/apps/website/.vuepress/public/demos/button/icon-css.html index 16f5f34ad2..9ecfd6bf6f 100644 --- a/apps/website/.vuepress/public/demos/button/icon-css.html +++ b/apps/website/.vuepress/public/demos/button/icon-css.html @@ -1,18 +1,18 @@ diff --git a/apps/website/.vuepress/public/demos/button/types-css.html b/apps/website/.vuepress/public/demos/button/types-css.html index a9c5a8f01f..facdff02a9 100644 --- a/apps/website/.vuepress/public/demos/button/types-css.html +++ b/apps/website/.vuepress/public/demos/button/types-css.html @@ -1,9 +1,3 @@ - - diff --git a/apps/website/.vuepress/public/demos/card/clickable-css.html b/apps/website/.vuepress/public/demos/card/clickable-css.html index 70c51a065c..c6ee4d783f 100644 --- a/apps/website/.vuepress/public/demos/card/clickable-css.html +++ b/apps/website/.vuepress/public/demos/card/clickable-css.html @@ -1,9 +1,3 @@ - -
diff --git a/apps/website/.vuepress/public/demos/card/dropdown-css.html b/apps/website/.vuepress/public/demos/card/dropdown-css.html index a29e0df58a..aa7ee1332b 100644 --- a/apps/website/.vuepress/public/demos/card/dropdown-css.html +++ b/apps/website/.vuepress/public/demos/card/dropdown-css.html @@ -22,7 +22,7 @@