From 3bb388bceffcd4d6911511f9f9e82344d447cc1b Mon Sep 17 00:00:00 2001 From: Andrew Scott Date: Fri, 15 Dec 2023 16:52:00 -0800 Subject: [PATCH] docs: convert to vitepress --- .github/workflows/docs.yml | 5 +- .gitignore | 1 + .../components/CodeTabs.vue | 22 +- .../components/Prop.vue | 15 +- docs/.vitepress/components/SiteFooter.vue | 62 + docs/.vitepress/config.mts | 175 + .../importMdPlugin.ts | 17 +- .../linkcheck-skip-file.txt | 0 docs/.vitepress/theme/index.ts | 25 + docs/.vitepress/theme/style.scss | 208 + docs/.vuepress/clientAppEnhance.ts | 48 - docs/.vuepress/config.ts | 154 - docs/.vuepress/styles/index.scss | 57 - docs/.vuepress/styles/palette.scss | 0 docs/concepts/include-tree.md | 2 - docs/concepts/includes.md | 5 +- docs/cspell.json | 1 + docs/index.md | 76 +- docs/introduction.md | 85 + docs/modeling/model-components/attributes.md | 2 - .../attributes/client-validation.md | 2 - .../attributes/load-from-data-source.md | 3 +- .../attributes/security-attribute.md | 10 +- docs/modeling/model-components/behaviors.md | 2 - .../modeling/model-components/data-sources.md | 2 - docs/modeling/model-components/methods.md | 6 +- docs/modeling/model-components/properties.md | 8 +- docs/modeling/model-types/dtos.md | 2 - docs/modeling/model-types/entities.md | 2 - docs/modeling/model-types/services.md | 6 +- docs/package-lock.json | 13335 +++++----------- docs/package.json | 13 +- docs/public/coalesce-horizontal-color.svg | 96 + docs/public/coalesce-icon-color.svg | 36 + docs/public/ef-logo.svg | 5 + docs/public/favicon.ico | Bin 0 -> 15086 bytes docs/public/intellitect-text-black.svg | 59 + docs/public/intellitect-text-white.svg | 59 + docs/public/net-logo.svg | 7 + docs/public/ts-logo-128.svg | 1 + docs/public/ts-logo-512.svg | 1 + docs/public/vite-logo.svg | 15 + docs/public/vue-logo.svg | 8 + docs/stacks/agnostic/generation.md | 2 - docs/stacks/ko/client/bindings.md | 2 - docs/stacks/ko/client/external-view-model.md | 2 - docs/stacks/ko/client/list-view-model.md | 2 - docs/stacks/ko/client/methods.md | 2 - docs/stacks/ko/client/view-model.md | 2 - docs/stacks/ko/overview.md | 2 - .../components/c-datetime-picker.md | 2 - .../components/c-display.md | 2 - .../components/c-input.md | 2 - .../components/c-loader-status.md | 2 - .../components/c-select-many-to-many.md | 2 - .../components/c-select-string-value.md | 2 - .../components/c-select-values.md | 2 - .../components/c-select.md | 2 - .../components/c-table.md | 2 - .../vue/coalesce-vue-vuetify/overview.md | 6 +- docs/stacks/vue/getting-started.md | 8 +- docs/stacks/vue/layers/api-clients.md | 5 +- docs/stacks/vue/layers/metadata.md | 2 - docs/stacks/vue/layers/models.md | 2 - docs/stacks/vue/layers/viewmodels.md | 2 - docs/stacks/vue/overview.md | 6 +- docs/stacks/vue/vue2-to-vue3.md | 21 +- 67 files changed, 4948 insertions(+), 9774 deletions(-) rename docs/{.vuepress => .vitepress}/components/CodeTabs.vue (92%) rename docs/{.vuepress => .vitepress}/components/Prop.vue (94%) create mode 100644 docs/.vitepress/components/SiteFooter.vue create mode 100644 docs/.vitepress/config.mts rename docs/{.vuepress => .vitepress}/importMdPlugin.ts (95%) rename docs/{.vuepress => .vitepress}/linkcheck-skip-file.txt (100%) create mode 100644 docs/.vitepress/theme/index.ts create mode 100644 docs/.vitepress/theme/style.scss delete mode 100644 docs/.vuepress/clientAppEnhance.ts delete mode 100644 docs/.vuepress/config.ts delete mode 100644 docs/.vuepress/styles/index.scss delete mode 100644 docs/.vuepress/styles/palette.scss create mode 100644 docs/introduction.md create mode 100644 docs/public/coalesce-horizontal-color.svg create mode 100644 docs/public/coalesce-icon-color.svg create mode 100644 docs/public/ef-logo.svg create mode 100644 docs/public/favicon.ico create mode 100644 docs/public/intellitect-text-black.svg create mode 100644 docs/public/intellitect-text-white.svg create mode 100644 docs/public/net-logo.svg create mode 100644 docs/public/ts-logo-128.svg create mode 100644 docs/public/ts-logo-512.svg create mode 100644 docs/public/vite-logo.svg create mode 100644 docs/public/vue-logo.svg diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 789b69d27..5e6b60019 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -37,7 +37,7 @@ jobs: run: npm ci # run build script - - name: Build VuePress site + - name: Build Site run: npm run build # please check out the docs of the workflow for more details @@ -48,8 +48,7 @@ jobs: with: # deploy to gh-pages branch target_branch: gh-pages - # deploy the default output of VuePress - build_dir: docs/.vuepress/dist/Coalesce + build_dir: docs/.vitepress/dist/Coalesce jekyll: false env: # @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret diff --git a/.gitignore b/.gitignore index d59e75457..8263e8dc7 100644 --- a/.gitignore +++ b/.gitignore @@ -19,6 +19,7 @@ docs_old/ #vuepress .cache/ .temp/ +**/.vitepress/cache/ ## Ignore Visual Studio temporary files, build results, and diff --git a/docs/.vuepress/components/CodeTabs.vue b/docs/.vitepress/components/CodeTabs.vue similarity index 92% rename from docs/.vuepress/components/CodeTabs.vue rename to docs/.vitepress/components/CodeTabs.vue index 1c9d03047..0a48661d5 100644 --- a/docs/.vuepress/components/CodeTabs.vue +++ b/docs/.vitepress/components/CodeTabs.vue @@ -41,13 +41,11 @@ .code-tabs__nav { margin-top: 0.85rem; // 2 * margin + border-radius of 
 tag
-  margin-bottom: calc(-1.7rem - 6px);
-  padding-bottom: calc(1.7rem - 6px);
+  margin-bottom: -20px;
   padding-left: 10px;
-  padding-top: 10px;
   border-top-left-radius: 6px;
   border-top-right-radius: 6px;
-  background-color: var(--code-bg-color);
+  background-color: var(--vp-code-block-bg);
 }
 
 .code-tabs__ul {
@@ -55,7 +53,11 @@
   margin-bottom: 5px;
   padding-left: 0;
   display: inline-flex;
-  list-style: none;
+  list-style: none !important;
+}
+.code-tabs__li {
+  
+  margin-top: 0 !important;
 }
 
 .code-tabs__nav-tab {
@@ -78,7 +80,7 @@
 }
 
 .code-tabs__nav-tab-active {
-  border-bottom: var(--c-brand) 2px solid;
+  border-bottom: var(--vp-c-brand-1) 2px solid;
 }
 
 @media (max-width: 500px) {
@@ -91,14 +93,14 @@
 
 .code-tabs-item {
   color: #adbac7;
-  background-color: var(--code-bg-color);
+  background-color: var(--vp-code-block-bg);
   div[class*=language-]::before {
     top: 5px;
   }
   
   // Give some horizontal padding to items that arent code
-  > :not(.line-numbers-mode) {
-    padding: 0 20px
+  > :not([class*='language-']) {
+    padding: 0 24px
   }
 
   pre, pre + div {
@@ -113,7 +115,7 @@
 
 ```
 
-Alternatively, props can be declared with type-only syntax,
-which is more concise but is a little more clunky when props have default values:
-```vue
-
-```
-