Merge pull request #377 from vuejs-jp/enhance/update-docs

update peatix readme, others
vuejs-jp · Oct 12, 2024 · 7ca7c91 · 7ca7c91
2 parents 207e8e3 + 5c90e5e
commit 7ca7c91
Show file tree

Hide file tree

Showing 15 changed files with 1,152 additions and 608 deletions.
diff --git a/apps/web-docs/.vitepress/config.mts b/apps/web-docs/.vitepress/config.mts
@@ -9,7 +9,21 @@ export default defineConfig({
     nav: [
       { text: 'Top', link: '/' },
       { text: 'CSS', link: '/css/getting-started' },
-      { text: 'Peatix', link: '/peatix/csv-usage' },
+      {
+        text: 'RPA',
+        items: [
+          {
+            text: 'Getting Started',
+            link: '/rpa/getting-started',
+          },
+          {
+            text: 'Peatix',
+            items: [
+              { text: 'Download CSV', link: '/rpa/peatix/csv' },
+            ],
+          },
+        ],
+      },
       {
         text: 'Supabase',
         items: [
@@ -36,7 +50,22 @@ export default defineConfig({
         text: 'Examples',
         items: [
           { text: 'CSS', link: '/css/getting-started' },
-          { text: 'Peatix', link: '/peatix/csv-usage' },
+          {
+            text: 'RPA',
+            items: [
+              {
+                text: 'Getting Started',
+                link: '/rpa/getting-started',
+              },
+              {
+                text: 'Peatix',
+                items: [
+                  { text: 'Download CSV', link: '/rpa/peatix/csv' },
+                  { text: 'Fetch JSON data', link: '/rpa/peatix/json' },
+                ],
+              },
+            ],
+          },
           {
             text: 'Supabase',
             items: [

diff --git a/apps/web-docs/.vitepress/theme/style.css b/apps/web-docs/.vitepress/theme/style.css
@@ -1,89 +1,24 @@
+@import '@vuejs-jp/css/base.css';
+
 /**
  * Customize default theme styling by overriding CSS variables:
  * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
  */
 
-/**
- * Colors
- *
- * Each colors have exact same color scale system with 3 levels of solid
- * colors with different brightness, and 1 soft color.
- * 
- * - `XXX-1`: The most solid color used mainly for colored text. It must
- *   satisfy the contrast ratio against when used on top of `XXX-soft`.
- *
- * - `XXX-2`: The color used mainly for hover state of the button.
- *
- * - `XXX-3`: The color for solid background, such as bg color of the button.
- *   It must satisfy the contrast ratio with pure white (#ffffff) text on
- *   top of it.
- *
- * - `XXX-soft`: The color used for subtle background such as custom container
- *   or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
- *   on top of it.
- *
- *   The soft color must be semi transparent alpha channel. This is crucial
- *   because it allows adding multiple "soft" colors on top of each other
- *   to create a accent, such as when having inline code block inside
- *   custom containers.
- *
- * - `default`: The color used purely for subtle indication without any
- *   special meanings attched to it such as bg color for menu hover state.
- *
- * - `brand`: Used for primary brand colors, such as link text, button with
- *   brand theme, etc.
- *
- * - `tip`: Used to indicate useful information. The default theme uses the
- *   brand color for this by default.
- *
- * - `warning`: Used to indicate warning to the users. Used in custom
- *   container, badges, etc.
- *
- * - `danger`: Used to show error, or dangerous message to the users. Used
- *   in custom container, badges, etc.
- * -------------------------------------------------------------------------- */
-
-:root {
-  --vp-c-default-1: var(--vp-c-gray-1);
-  --vp-c-default-2: var(--vp-c-gray-2);
-  --vp-c-default-3: var(--vp-c-gray-3);
-  --vp-c-default-soft: var(--vp-c-gray-soft);
-
-  --vp-c-brand-1: var(--vp-c-indigo-1);
-  --vp-c-brand-2: var(--vp-c-indigo-2);
-  --vp-c-brand-3: var(--vp-c-indigo-3);
-  --vp-c-brand-soft: var(--vp-c-indigo-soft);
-
-  --vp-c-tip-1: var(--vp-c-brand-1);
-  --vp-c-tip-2: var(--vp-c-brand-2);
-  --vp-c-tip-3: var(--vp-c-brand-3);
-  --vp-c-tip-soft: var(--vp-c-brand-soft);
-
-  --vp-c-warning-1: var(--vp-c-yellow-1);
-  --vp-c-warning-2: var(--vp-c-yellow-2);
-  --vp-c-warning-3: var(--vp-c-yellow-3);
-  --vp-c-warning-soft: var(--vp-c-yellow-soft);
-
-  --vp-c-danger-1: var(--vp-c-red-1);
-  --vp-c-danger-2: var(--vp-c-red-2);
-  --vp-c-danger-3: var(--vp-c-red-3);
-  --vp-c-danger-soft: var(--vp-c-red-soft);
-}
-
 /**
  * Component: Button
  * -------------------------------------------------------------------------- */
 
 :root {
   --vp-button-brand-border: transparent;
-  --vp-button-brand-text: var(--vp-c-white);
-  --vp-button-brand-bg: var(--vp-c-brand-3);
+  --vp-button-brand-text: var(--color-white);
+  --vp-button-brand-bg: var(--color-asagi100);
   --vp-button-brand-hover-border: transparent;
-  --vp-button-brand-hover-text: var(--vp-c-white);
-  --vp-button-brand-hover-bg: var(--vp-c-brand-2);
+  --vp-button-brand-hover-text: var(--color-white);
+  --vp-button-brand-hover-bg: var(--color-asagi200);
   --vp-button-brand-active-border: transparent;
-  --vp-button-brand-active-text: var(--vp-c-white);
-  --vp-button-brand-active-bg: var(--vp-c-brand-1);
+  --vp-button-brand-active-text: var(--color-white);
+  --vp-button-brand-active-bg: var(--color-vue-blue);
 }
 
 /**
@@ -94,14 +29,14 @@
   --vp-home-hero-name-color: transparent;
   --vp-home-hero-name-background: -webkit-linear-gradient(
     120deg,
-    #bd34fe 30%,
-    #41d1ff
+    var(--color-vue-green200) 30%,
+    var(--color-vue-green100)
   );
 
   --vp-home-hero-image-background-image: linear-gradient(
     -45deg,
-    #bd34fe 50%,
-    #47caff 50%
+    var(--color-vue-green200) 50%,
+    var(--color-vue-green100) 50%
   );
   --vp-home-hero-image-filter: blur(44px);
 }
@@ -117,23 +52,3 @@
     --vp-home-hero-image-filter: blur(68px);
   }
 }
-
-/**
- * Component: Custom Block
- * -------------------------------------------------------------------------- */
-
-:root {
-  --vp-custom-block-tip-border: transparent;
-  --vp-custom-block-tip-text: var(--vp-c-text-1);
-  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
-  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
-}
-
-/**
- * Component: Algolia
- * -------------------------------------------------------------------------- */
-
-.DocSearch {
-  --docsearch-primary-color: var(--vp-c-brand-1) !important;
-}
-
diff --git a/apps/web-docs/index.md b/apps/web-docs/index.md
@@ -9,8 +9,8 @@ hero:
       text: CSS
       link: /css/getting-started
     - theme: brand
-      text: Peatix
-      link: /peatix/csv-usage
+      text: RPA
+      link: /rpa/getting-started
     - theme: brand
       text: Supabase
       link: /supabase/getting-started

diff --git a/apps/web-docs/package.json b/apps/web-docs/package.json
@@ -12,6 +12,7 @@
     "textlint-fix": "textlint ./** --fix"
   },
   "devDependencies": {
+    "@vuejs-jp/css": "workspace:*",
     "textlint": "14.0.4",
     "textlint-filter-rule-allowlist": "4.0.0",
     "textlint-rule-preset-vuejs-jp": "github:vuejs-jp/textlint-rule-preset-vuejs-jp",