Merge pull request #2 from elsiosanchez/feature/docs-initial-commit

Add Config the Docs

.github/workflows/deploy-docs.yml

@@ -0,0 +1,50 @@
+
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      # make sure this is the branch you are using
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy-gh-pages:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          # if your docs needs submodules, uncomment the following line
+          # submodules: true
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          run_install: true
+          version: 8
+
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: pnpm
+
+
+      - name: Build Docs
+        env:
+          NODE_OPTIONS: --max_old_space_size=8192
+        run: |-
+          pnpm run docs:build
+          > docs/.vuepress/dist/.nojekyll
+
+      - name: Deploy Docs
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          # This is the branch where the docs are deployed to
+          branch: gh-pages
+          folder: docs/.vuepress/dist

.gitignore

@@ -0,0 +1,5 @@
+
+node_modules/
+docs/.vuepress/.cache/
+docs/.vuepress/.temp/
+docs/.vuepress/dist/

docs/.vuepress/config.ts

@@ -0,0 +1,29 @@
+import { defineUserConfig } from "vuepress";
+import theme from "./theme.ts";
+
+export default defineUserConfig({
+  base: "/",
+
+  locales: {
+    "/": {
+      lang: "en-US",
+      title: "Adempiere UI",
+      description: "",
+    },
+    "/es/": {
+      lang: "es-ES",
+      title: 'Adempiere Interfaz Usuario',
+      description: 'Una documentación de definición de interfaz de usuario basada en componentes, composiciones y diseños de patrones.',
+    },
+    // "/zh/": {
+    //   lang: "zh-CN",
+    //   title: "博客演示",
+    //   description: "vuepress-theme-hope 的博客演示",
+    // },
+  },
+
+  theme,
+
+  // Enable it with pwa
+  // shouldPrefetch: false,
+});

docs/.vuepress/logo.ts

@@ -0,0 +1,2 @@
+export const MR_HOPE_AVATAR =
+  '<svg viewBox="0 0 1000 1000" xmlns="http://www.w3.org/2000/svg"><defs><linearGradient gradientTransform="matrix(.2478 .78133 -2.54797 .63622 910.35 281.58)" gradientUnits="userSpaceOnUse" id="a" x1="37.827" x2="159.988" y1="272.916" y2="274.63"><stop offset=".75" stop-color="#e33939"/><stop offset=".998" stop-color="#fff"/></linearGradient><linearGradient gradientTransform="matrix(.13814 .80797 2.55599 -.6032 34.087 494.369)" gradientUnits="userSpaceOnUse" id="b" x1="37.827" x2="159.988" y1="272.916" y2="274.63"><stop offset=".815" stop-color="#e33939"/><stop offset="1" stop-color="#fff"/></linearGradient></defs><path d="M135.637 588.067c-48.891-201.334 74.605-404.162 275.837-453.028 201.233-48.866 403.998 74.734 452.889 276.068 48.892 201.335-74.606 404.162-275.838 453.029-201.233 48.866-403.997-74.734-452.888-276.069Z" fill="#fde68a" fill-rule="evenodd" stroke="#d08819" stroke-linecap="round" stroke-linejoin="round" stroke-width="10"/><path d="M596.076 197.044c-3.342-56.09 56.897-77.831 89.017-51.361m-410.65 128.819c-22.753-51.377-86.256-43.07-102.659-4.816" fill="none" stroke="#6d5e56" stroke-linecap="round" stroke-linejoin="round" stroke-width="11"/><path d="M833.568 288.02c.05 18.046-12.584 30.699-21.346 32.211-8.762 1.512-17.031-1.099-18.584-1.341 0 0-61.363-6.103-105.627 6.921-44.265 13.026-87.04 47.387-94.637 51.892-6.627 3.928-29.112 7.697-44.462-12.938-15.351-20.636.024-41.526.024-41.526s12.685-18.279 40.771-35.123c28.088-16.844 24.624-13.226 52.326-25.696 15.247-6.865 43.319-14.186 67.429-17.069 25.193-3.011 46.348-1.384 57.673.769 22.165 4.212 28.632 5.93 39.169 9.229 12.451 3.898 27.214 14.516 27.264 32.671Z" fill="#fff" fill-rule="evenodd" stroke="#d08819" stroke-linecap="round" stroke-linejoin="round" stroke-width="8"/><path d="M558.351 345.632c-3.458-14.237 5.214-28.566 19.367-32.003 14.154-3.437 28.43 5.32 31.887 19.557 3.458 14.238-5.212 28.567-19.367 32.004-14.152 3.437-28.43-5.319-31.887-19.558Z" fill="#6d5e56" fill-rule="evenodd" stroke="#6d5e56" stroke-linecap="round" stroke-linejoin="round" stroke-width="6.268"/><path d="M220.249 483.416c46.81-11.689 91.323-.467 99.42 25.064 8.098 25.532-23.286 55.706-70.097 67.393-46.811 11.689-91.323.467-99.42-25.064-8.097-25.532 23.286-55.706 70.097-67.393Z" fill="url(#a)" fill-rule="evenodd" opacity=".261"/><path d="M739.9 357.226c-46.959 11.082-81.367 41.469-76.853 67.871 4.514 26.402 46.241 38.821 93.198 27.738 46.958-11.081 81.366-41.467 76.853-67.869-4.514-26.403-46.241-38.821-93.198-27.74Z" fill="url(#b)" fill-rule="evenodd" opacity=".261"/><path d="M400.934 398.917c-.599 18.034-13.681 30.218-22.494 31.409-8.812 1.192-16.982-1.716-18.526-2.014 0 0-61.109-8.334-105.819 3.07-44.709 11.404-88.696 44.181-96.452 48.406-6.763 3.683-29.372 6.632-43.972-14.546-14.6-21.18 1.519-41.494 1.519-41.494s13.335-17.803 42.013-33.612c28.677-15.809 25.085-12.319 53.222-23.772 15.484-6.304 43.803-12.598 68.005-14.6 25.288-2.093 46.373.305 57.616 2.867 22 5.016 28.401 6.968 38.813 10.649 12.304 4.348 26.677 15.496 26.075 33.637Z" fill="#fff" fill-rule="evenodd" stroke="#d08819" stroke-linecap="round" stroke-linejoin="round" stroke-width="8"/><path d="M129.05 445.546c-3.458-14.239 5.213-28.566 19.367-32.003 14.153-3.437 28.429 5.318 31.887 19.557 3.458 14.238-5.213 28.566-19.367 32.003-14.153 3.437-28.43-5.318-31.887-19.557Z" fill="#6d5e56" fill-rule="evenodd" stroke="#6d5e56" stroke-linecap="round" stroke-linejoin="round" stroke-width="6.268"/><path d="M424.381 696.386s64.427 13.646 101.996 5.757C640.653 678.146 690.8 521.894 690.8 521.894" fill="none" stroke="#d08819" stroke-linecap="round" stroke-linejoin="round" stroke-width="11"/><path d="M796.04 666.774s-10.734-44.165-41.405-11.348c-9.681 10.359-10.438 40.604-28.217 81.89-15.942 37.02-39.564 60.728-42.938 76.063-3.374 15.335.451 35.992 26.352 41.537 25.902 5.545 41.967-23.381 41.967-23.381l44.241-164.761Z" fill="#fde68a" fill-rule="evenodd" stroke="#d08819" stroke-linecap="round" stroke-linejoin="round" stroke-width="10"/><path d="M793.337 664.734c-37.075 160.045-51.73 163.145-40.343 184.845 11.387 21.701 51.417 33.716 71.876-7.313 6.734-13.505-1.31-43.317-1.511-78.077-.307-53.06 16.865-86.111 10.403-98.1-15.332-28.452-39.377-5.875-40.425-1.355Z" fill="#fde68a" fill-rule="evenodd" stroke="#d08819" stroke-linecap="round" stroke-linejoin="round" stroke-width="10"/></svg>';

docs/.vuepress/navbar/en.ts

@@ -0,0 +1,6 @@
+import { navbar } from "vuepress-theme-hope";
+
+export const enNavbar = navbar([
+  { text: "Get Started", icon: "rocket", link: "/get-started/" },
+  { text: "Guia", icon: "signs-post", link: "/guide/" },
+]);

docs/.vuepress/navbar/es.ts

@@ -0,0 +1,7 @@
+import { navbar } from "vuepress-theme-hope";
+
+export const esNavbar = navbar([
+  "/es/",
+  { text: "Empezar", icon: "rocket", link: "/es/get-started/" },
+  { text: "Guia", icon: "signs-post", link: "/es/guide/" },
+]);

docs/.vuepress/navbar/index.ts

@@ -0,0 +1,3 @@
+export * from "./en.ts";
+export * from "./es.ts";
+export * from "./zh.ts";

docs/.vuepress/navbar/zh.ts

@@ -0,0 +1,52 @@
+import { navbar } from "vuepress-theme-hope";
+
+export const zhNavbar = navbar([
+  "/zh/",
+  "/zh/demo/",
+  {
+    text: "博文",
+    icon: "pen-to-square",
+    prefix: "/zh/posts/",
+    children: [
+      {
+        text: "苹果",
+        icon: "pen-to-square",
+        prefix: "apple/",
+        children: [
+          { text: "苹果1", icon: "pen-to-square", link: "1" },
+          { text: "苹果2", icon: "pen-to-square", link: "2" },
+          "3",
+          "4",
+        ],
+      },
+      {
+        text: "香蕉",
+        icon: "pen-to-square",
+        prefix: "banana/",
+        children: [
+          {
+            text: "香蕉 1",
+            icon: "pen-to-square",
+            link: "1",
+          },
+          {
+            text: "香蕉 2",
+            icon: "pen-to-square",
+            link: "2",
+          },
+          "3",
+          "4",
+        ],
+      },
+      { text: "樱桃", icon: "pen-to-square", link: "cherry" },
+      { text: "火龙果", icon: "pen-to-square", link: "dragonfruit" },
+      "tomato",
+      "strawberry",
+    ],
+  },
+  {
+    text: "V2 文档",
+    icon: "book",
+    link: "https://theme-hope.vuejs.press/zh/",
+  },
+]);

docs/.vuepress/sidebar/en.ts

@@ -0,0 +1,8 @@
+import { sidebar } from "vuepress-theme-hope";
+
+export const enSidebar = sidebar({
+  "/": [
+    "",
+    "get-started/",
+  ],
+});

docs/.vuepress/sidebar/es.ts

@@ -0,0 +1,13 @@
+import { sidebar } from "vuepress-theme-hope";
+
+export const esSidebar = sidebar({
+  "/es/": [
+    "",
+    {
+      text: "Documentación",
+      icon: "signs-post",
+      prefix: "docs/",
+      children: "structure",
+    }
+  ],
+});

docs/.vuepress/sidebar/index.ts

@@ -0,0 +1,3 @@
+export * from "./en.ts";
+export * from "./es.ts";
+export * from "./zh.ts";

docs/.vuepress/sidebar/zh.ts

@@ -0,0 +1,26 @@
+import { sidebar } from "vuepress-theme-hope";
+
+export const zhSidebar = sidebar({
+  "/zh/": [
+    "",
+    {
+      text: "如何使用",
+      icon: "laptop-code",
+      prefix: "demo/",
+      link: "demo/",
+      children: "structure",
+    },
+    {
+      text: "文章",
+      icon: "book",
+      prefix: "posts/",
+      children: "structure",
+    },
+    "intro",
+    {
+      text: "幻灯片",
+      icon: "person-chalkboard",
+      link: "https://plugin-md-enhance.vuejs.press/zh/guide/content/revealjs/demo.html",
+    },
+  ],
+});

docs/.vuepress/styles/config.scss

@@ -0,0 +1,3 @@
+// you can change config here
+$colors: #c0392b, #d35400, #f39c12, #27ae60, #16a085, #2980b9, #8e44ad, #2c3e50,
+  #7f8c8d !default;

docs/.vuepress/styles/index.scss

@@ -0,0 +1 @@
+// place your custom styles here

docs/.vuepress/styles/palette.scss

@@ -0,0 +1,2 @@
+// you can change colors here
+$theme-color: #096dd9;