diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml new file mode 100644 index 0000000..3966a5f --- /dev/null +++ b/.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 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fb69675 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ + +node_modules/ +docs/.vuepress/.cache/ +docs/.vuepress/.temp/ +docs/.vuepress/dist/ diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts new file mode 100644 index 0000000..95d7275 --- /dev/null +++ b/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, +}); diff --git a/docs/.vuepress/logo.ts b/docs/.vuepress/logo.ts new file mode 100644 index 0000000..da922b3 --- /dev/null +++ b/docs/.vuepress/logo.ts @@ -0,0 +1,2 @@ +export const MR_HOPE_AVATAR = + ''; diff --git a/docs/.vuepress/navbar/en.ts b/docs/.vuepress/navbar/en.ts new file mode 100644 index 0000000..25e9cfb --- /dev/null +++ b/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/" }, +]); diff --git a/docs/.vuepress/navbar/es.ts b/docs/.vuepress/navbar/es.ts new file mode 100644 index 0000000..3b8e293 --- /dev/null +++ b/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/" }, +]); diff --git a/docs/.vuepress/navbar/index.ts b/docs/.vuepress/navbar/index.ts new file mode 100644 index 0000000..17e7f3d --- /dev/null +++ b/docs/.vuepress/navbar/index.ts @@ -0,0 +1,3 @@ +export * from "./en.ts"; +export * from "./es.ts"; +export * from "./zh.ts"; diff --git a/docs/.vuepress/navbar/zh.ts b/docs/.vuepress/navbar/zh.ts new file mode 100644 index 0000000..512b2ae --- /dev/null +++ b/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/", + }, +]); diff --git a/docs/.vuepress/public/assets/icon/apple-icon-152.png b/docs/.vuepress/public/assets/icon/apple-icon-152.png new file mode 100644 index 0000000..434fcc3 Binary files /dev/null and b/docs/.vuepress/public/assets/icon/apple-icon-152.png differ diff --git a/docs/.vuepress/public/assets/icon/chrome-192.png b/docs/.vuepress/public/assets/icon/chrome-192.png new file mode 100644 index 0000000..6645f52 Binary files /dev/null and b/docs/.vuepress/public/assets/icon/chrome-192.png differ diff --git a/docs/.vuepress/public/assets/icon/chrome-512.png b/docs/.vuepress/public/assets/icon/chrome-512.png new file mode 100644 index 0000000..a146f00 Binary files /dev/null and b/docs/.vuepress/public/assets/icon/chrome-512.png differ diff --git a/docs/.vuepress/public/assets/icon/chrome-mask-192.png b/docs/.vuepress/public/assets/icon/chrome-mask-192.png new file mode 100644 index 0000000..530977a Binary files /dev/null and b/docs/.vuepress/public/assets/icon/chrome-mask-192.png differ diff --git a/docs/.vuepress/public/assets/icon/chrome-mask-512.png b/docs/.vuepress/public/assets/icon/chrome-mask-512.png new file mode 100644 index 0000000..a4f90ae Binary files /dev/null and b/docs/.vuepress/public/assets/icon/chrome-mask-512.png differ diff --git a/docs/.vuepress/public/assets/icon/guide-maskable.png b/docs/.vuepress/public/assets/icon/guide-maskable.png new file mode 100644 index 0000000..75449b6 Binary files /dev/null and b/docs/.vuepress/public/assets/icon/guide-maskable.png differ diff --git a/docs/.vuepress/public/assets/icon/logo.png b/docs/.vuepress/public/assets/icon/logo.png new file mode 100644 index 0000000..e86a989 Binary files /dev/null and b/docs/.vuepress/public/assets/icon/logo.png differ diff --git a/docs/.vuepress/public/assets/icon/ms-icon-144.png b/docs/.vuepress/public/assets/icon/ms-icon-144.png new file mode 100644 index 0000000..2464124 Binary files /dev/null and b/docs/.vuepress/public/assets/icon/ms-icon-144.png differ diff --git a/docs/.vuepress/public/assets/images/cover1.jpg b/docs/.vuepress/public/assets/images/cover1.jpg new file mode 100644 index 0000000..06f33cf Binary files /dev/null and b/docs/.vuepress/public/assets/images/cover1.jpg differ diff --git a/docs/.vuepress/public/assets/images/cover2.jpg b/docs/.vuepress/public/assets/images/cover2.jpg new file mode 100644 index 0000000..edf5b38 Binary files /dev/null and b/docs/.vuepress/public/assets/images/cover2.jpg differ diff --git a/docs/.vuepress/public/assets/images/cover3.jpg b/docs/.vuepress/public/assets/images/cover3.jpg new file mode 100644 index 0000000..ad79fc9 Binary files /dev/null and b/docs/.vuepress/public/assets/images/cover3.jpg differ diff --git a/docs/.vuepress/public/assets/images/vue-logo.png b/docs/.vuepress/public/assets/images/vue-logo.png new file mode 100644 index 0000000..04e665e Binary files /dev/null and b/docs/.vuepress/public/assets/images/vue-logo.png differ diff --git a/docs/.vuepress/public/favicon.ico b/docs/.vuepress/public/favicon.ico new file mode 100644 index 0000000..2dc7ed2 Binary files /dev/null and b/docs/.vuepress/public/favicon.ico differ diff --git a/docs/.vuepress/public/logo.png b/docs/.vuepress/public/logo.png new file mode 100644 index 0000000..e86a989 Binary files /dev/null and b/docs/.vuepress/public/logo.png differ diff --git a/docs/.vuepress/public/logo.svg b/docs/.vuepress/public/logo.svg new file mode 100644 index 0000000..a84dabe --- /dev/null +++ b/docs/.vuepress/public/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/.vuepress/sidebar/en.ts b/docs/.vuepress/sidebar/en.ts new file mode 100644 index 0000000..b35a866 --- /dev/null +++ b/docs/.vuepress/sidebar/en.ts @@ -0,0 +1,8 @@ +import { sidebar } from "vuepress-theme-hope"; + +export const enSidebar = sidebar({ + "/": [ + "", + "get-started/", + ], +}); diff --git a/docs/.vuepress/sidebar/es.ts b/docs/.vuepress/sidebar/es.ts new file mode 100644 index 0000000..2d6ac01 --- /dev/null +++ b/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", + } + ], +}); diff --git a/docs/.vuepress/sidebar/index.ts b/docs/.vuepress/sidebar/index.ts new file mode 100644 index 0000000..17e7f3d --- /dev/null +++ b/docs/.vuepress/sidebar/index.ts @@ -0,0 +1,3 @@ +export * from "./en.ts"; +export * from "./es.ts"; +export * from "./zh.ts"; diff --git a/docs/.vuepress/sidebar/zh.ts b/docs/.vuepress/sidebar/zh.ts new file mode 100644 index 0000000..8e3f1a9 --- /dev/null +++ b/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", + }, + ], +}); diff --git a/docs/.vuepress/styles/config.scss b/docs/.vuepress/styles/config.scss new file mode 100644 index 0000000..f91061d --- /dev/null +++ b/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; diff --git a/docs/.vuepress/styles/index.scss b/docs/.vuepress/styles/index.scss new file mode 100644 index 0000000..f6af387 --- /dev/null +++ b/docs/.vuepress/styles/index.scss @@ -0,0 +1 @@ +// place your custom styles here diff --git a/docs/.vuepress/styles/palette.scss b/docs/.vuepress/styles/palette.scss new file mode 100644 index 0000000..356a428 --- /dev/null +++ b/docs/.vuepress/styles/palette.scss @@ -0,0 +1,2 @@ +// you can change colors here +$theme-color: #096dd9; diff --git a/docs/.vuepress/theme.ts b/docs/.vuepress/theme.ts new file mode 100644 index 0000000..29f0ee1 --- /dev/null +++ b/docs/.vuepress/theme.ts @@ -0,0 +1,292 @@ +import { hopeTheme } from "vuepress-theme-hope"; +import { enNavbar, zhNavbar, esNavbar } from "./navbar/index.ts"; +import { enSidebar, zhSidebar, esSidebar } from "./sidebar/index.ts"; +import { MR_HOPE_AVATAR } from "./logo.js"; + +export default hopeTheme({ + hostname: "https://github.com/adempiere/vue-ui-theme.github.io", + + author: { + name: "Elsio Sanchez", + url: "https://github.com/elsiosanchez", + }, + + iconAssets: "fontawesome-with-brands", + + logo: "/logo.svg", + + repo: "https://github.com/adempiere/vue-ui-theme", + + docsDir: "src", + + themeColor: true, + + fullscreen: true, + + // blog: { + // medias: { + // Baidu: "https://example.com", + // BiliBili: "https://example.com", + // Bitbucket: "https://example.com", + // Dingding: "https://example.com", + // Discord: "https://example.com", + // Dribbble: "https://example.com", + // Email: "mailto:info@example.com", + // Evernote: "https://example.com", + // Facebook: "https://example.com", + // Flipboard: "https://example.com", + // Gitee: "https://example.com", + // GitHub: "https://example.com", + // Gitlab: "https://example.com", + // Gmail: "mailto:info@example.com", + // Instagram: "https://example.com", + // Lark: "https://example.com", + // Lines: "https://example.com", + // Linkedin: "https://example.com", + // Pinterest: "https://example.com", + // Pocket: "https://example.com", + // QQ: "https://example.com", + // Qzone: "https://example.com", + // Reddit: "https://example.com", + // Rss: "https://example.com", + // Steam: "https://example.com", + // Twitter: "https://example.com", + // Wechat: "https://example.com", + // Weibo: "https://example.com", + // Whatsapp: "https://example.com", + // Youtube: "https://example.com", + // Zhihu: "https://example.com", + // MrHope: ["https://mister-hope.com", MR_HOPE_AVATAR], + // }, + // }, + + locales: { + "/": { + // navbar + navbar: enNavbar, + + // sidebar + sidebar: enSidebar, + + footer: "Default footer", + + displayFooter: true, + + blog: { + description: "A FrontEnd programmer", + intro: "/intro.html", + }, + + metaLocales: { + editLink: "Edit this page on GitHub", + }, + }, + + /** + * Spanish locale config + */ + "/es/": { + // navbar + navbar: esNavbar, + + // sidebar + sidebar: esSidebar, + + footer: "默认页脚", + + displayFooter: true, + + blog: { + description: "一个前端开发者", + intro: "/zh/intro.html", + }, + + // page meta + metaLocales: { + editLink: "在 GitHub 上编辑此页", + }, + }, + /** + * Chinese locale config + */ + "/zh/": { + // navbar + navbar: zhNavbar, + + // sidebar + sidebar: zhSidebar, + + footer: "默认页脚", + + displayFooter: true, + + blog: { + description: "一个前端开发者", + intro: "/zh/intro.html", + }, + + // page meta + metaLocales: { + editLink: "在 GitHub 上编辑此页", + }, + }, + }, + + encrypt: { + config: { + "/demo/encrypt.html": ["1234"], + "/zh/demo/encrypt.html": ["1234"], + }, + }, + + // enable it to preview all changes in time + // hotReload: true, + + plugins: { + blog: true, + + // install @waline/client before enabling it + // WARNING: This is a test server for demo only. + // You should create and use your own comment service in production. + // comment: { + // provider: "Waline", + // serverURL: "https://waline-comment.vuejs.press", + // }, + + components: { + components: ["Badge", "VPCard"], + }, + + feed: { + atom: true, + json: true, + rss: true, + }, + + // all features are enabled for demo, only preserve features you need here + mdEnhance: { + align: true, + attrs: true, + codetabs: true, + component: true, + demo: true, + figure: true, + imgLazyload: true, + imgSize: true, + include: true, + mark: true, + stylize: [ + { + matcher: "Recommended", + replacer: ({ tag }) => { + if (tag === "em") + return { + tag: "Badge", + attrs: { type: "tip" }, + content: "Recommended", + }; + }, + }, + ], + sub: true, + sup: true, + tabs: true, + vPre: true, + + // install chart.js before enabling it + // chart: true, + + // insert component easily + + // install echarts before enabling it + // echarts: true, + + // install flowchart.ts before enabling it + // flowchart: true, + + // gfm requires mathjax-full to provide tex support + // gfm: true, + + // install katex before enabling it + // katex: true, + + // install mathjax-full before enabling it + // mathjax: true, + + // install mermaid before enabling it + // mermaid: true, + + // playground: { + // presets: ["ts", "vue"], + // }, + + // install reveal.js before enabling it + // revealJs: { + // plugins: ["highlight", "math", "search", "notes", "zoom"], + // }, + + // install @vue/repl before enabling it + // vuePlayground: true, + + // install sandpack-vue3 before enabling it + // sandpack: true, + }, + + // install @vuepress/plugin-pwa and uncomment these if you want a PWA + // pwa: { + // favicon: "/favicon.ico", + // cacheHTML: true, + // cachePic: true, + // appendBase: true, + // apple: { + // icon: "/assets/icon/apple-icon-152.png", + // statusBarColor: "black", + // }, + // msTile: { + // image: "/assets/icon/ms-icon-144.png", + // color: "#ffffff", + // }, + // manifest: { + // icons: [ + // { + // src: "/assets/icon/chrome-mask-512.png", + // sizes: "512x512", + // purpose: "maskable", + // type: "image/png", + // }, + // { + // src: "/assets/icon/chrome-mask-192.png", + // sizes: "192x192", + // purpose: "maskable", + // type: "image/png", + // }, + // { + // src: "/assets/icon/chrome-512.png", + // sizes: "512x512", + // type: "image/png", + // }, + // { + // src: "/assets/icon/chrome-192.png", + // sizes: "192x192", + // type: "image/png", + // }, + // ], + // shortcuts: [ + // { + // name: "Demo", + // short_name: "Demo", + // url: "/demo/", + // icons: [ + // { + // src: "/assets/icon/guide-maskable.png", + // sizes: "192x192", + // purpose: "maskable", + // type: "image/png", + // }, + // ], + // }, + // ], + // }, + // }, + }, +}); diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..591a385 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,115 @@ +--- +home: true +icon: home +title: Home +heroImage: /logo.svg +heroText: UI Definitions Docs +tagline: The new UI for ADempiere ERP ✨ +actions: + - text: Get Started + link: /get-started/ + icon: rocket + type: primary + + - text: Guide + icon: signs-post + link: /guide/ + + # - text: Demos + # icon: star + # link: /demo/ + +# features: +# - title: Markdown Enhance +# icon: fab fa-markdown +# details: Add align, sup/sub script, footnote, tasklist, tex, flowchart, diagram, mark and presentation support in Markdown +# link: /guide/markdown/ + +# - title: Slide Page +# icon: person-chalkboard +# details: Adding slide pages to display things you like +# link: /guide/layout/slides + +# - title: Layout Enhancement +# icon: object-group +# details: Adding breadcrumb, footer, improved navbar, improved page nav and etc. +# link: /guide/layout/ + +# - title: Pageviews and Comments +# icon: comment-dots +# details: Start pageview statistics and comment support with Waline +# link: /guide/feature/comment.html + +# - title: Article Information +# icon: circle-info +# details: Add author, writing date, reading time, word count and other information to your article +# link: /guide/feature/page-info.html + +# - title: Blog Support +# icon: blog +# details: Listing your articles with their dates, tags and categories with some awesome layouts +# link: /guide/blog/ + +# - title: Customizable Theme Color +# icon: palette +# details: Customize theme color +# link: /guide/interface/theme-color.html + +# - title: Dark Mode +# icon: circle-half-stroke +# details: Switch between light and dark modes freely +# link: /guide/interface/darkmode.html + +# - title: Full A11y support +# icon: universal-access +# details: Full support of accessibility in your site +# link: /guide/interface/accessibility.html + +# - title: Article Encryption +# icon: lock +# details: Encrypt you articles based on page links, so that only the one you want could see them +# link: /guide/feature/encrypt.html + +# - title: Search +# icon: search +# details: Support docsearch and client search +# link: /guide/feature/search.html + +# - title: Copy Code Blocks +# icon: copy +# details: Copy codes with one click in code blocks +# link: /guide/feature/copy-code.html + +# - title: Image Preview +# icon: image +# details: Support viewing, zooming, sharing your page images like a gallery +# link: /guide/feature/photo-swipe.html + +# - title: SEO Enhancement +# icon: dumbbell +# details: Optimize pages for search engines +# link: /guide/advanced/seo.html + +# - title: Sitemap +# icon: sitemap +# details: Generate a Sitemap for your site +# link: /guide/advanced/sitemap.html + +# - title: Feed +# icon: rss +# details: Generate feed to allow users to subscribe it +# link: /guide/advanced/feed.html + +# - title: PWA +# icon: mobile-screen +# details: Make your site more like an APP +# link: /guide/advanced/pwa.html + +# - title: More New Features +# icon: ellipsis +# details: Including icon support, fullscreen button, etc. +# link: /guide/feature/ + +copyright: false +footer: MIT Licensed | Copyright © 2019-present Mr.Hope +--- \ No newline at end of file diff --git a/docs/es/README.md b/docs/es/README.md new file mode 100644 index 0000000..b00a0a2 --- /dev/null +++ b/docs/es/README.md @@ -0,0 +1,112 @@ +--- +home: true +icon: home +title: Inicio +heroImage: /logo.svg +heroText: Documentos sobre Definiciones de la UI +tagline: La nueva interfaz de usuario para ADempiere ERP ✨ +actions: + - text: Empezar + link: /es/get-started/ + icon: rocket + type: primary + + - text: Guia + icon: signs-post + link: /guide/ + +# features: +# - title: Markdown Enhance +# icon: fab fa-markdown +# details: Add align, sup/sub script, footnote, tasklist, tex, flowchart, diagram, mark and presentation support in Markdown +# link: /guide/markdown/ + +# - title: Slide Page +# icon: person-chalkboard +# details: Adding slide pages to display things you like +# link: /guide/layout/slides + +# - title: Layout Enhancement +# icon: object-group +# details: Adding breadcrumb, footer, improved navbar, improved page nav and etc. +# link: /guide/layout/ + +# - title: Pageviews and Comments +# icon: comment-dots +# details: Start pageview statistics and comment support with Waline +# link: /guide/feature/comment.html + +# - title: Article Information +# icon: circle-info +# details: Add author, writing date, reading time, word count and other information to your article +# link: /guide/feature/page-info.html + +# - title: Blog Support +# icon: blog +# details: Listing your articles with their dates, tags and categories with some awesome layouts +# link: /guide/blog/ + +# - title: Customizable Theme Color +# icon: palette +# details: Customize theme color +# link: /guide/interface/theme-color.html + +# - title: Dark Mode +# icon: circle-half-stroke +# details: Switch between light and dark modes freely +# link: /guide/interface/darkmode.html + +# - title: Full A11y support +# icon: universal-access +# details: Full support of accessibility in your site +# link: /guide/interface/accessibility.html + +# - title: Article Encryption +# icon: lock +# details: Encrypt you articles based on page links, so that only the one you want could see them +# link: /guide/feature/encrypt.html + +# - title: Search +# icon: search +# details: Support docsearch and client search +# link: /guide/feature/search.html + +# - title: Copy Code Blocks +# icon: copy +# details: Copy codes with one click in code blocks +# link: /guide/feature/copy-code.html + +# - title: Image Preview +# icon: image +# details: Support viewing, zooming, sharing your page images like a gallery +# link: /guide/feature/photo-swipe.html + +# - title: SEO Enhancement +# icon: dumbbell +# details: Optimize pages for search engines +# link: /guide/advanced/seo.html + +# - title: Sitemap +# icon: sitemap +# details: Generate a Sitemap for your site +# link: /guide/advanced/sitemap.html + +# - title: Feed +# icon: rss +# details: Generate feed to allow users to subscribe it +# link: /guide/advanced/feed.html + +# - title: PWA +# icon: mobile-screen +# details: Make your site more like an APP +# link: /guide/advanced/pwa.html + +# - title: More New Features +# icon: ellipsis +# details: Including icon support, fullscreen button, etc. +# link: /guide/feature/ + +copyright: false +footer: MIT Licensed | Copyright © 2019-present Mr.Hope +--- + diff --git a/docs/es/get-started/README.md b/docs/es/get-started/README.md new file mode 100644 index 0000000..2b804c0 --- /dev/null +++ b/docs/es/get-started/README.md @@ -0,0 +1,52 @@ +--- +title: Empezar +icon: signs-post +star: true +sticky: 10 +dir: + order: 1 +category: + - Cookbook + - Tutorial + - Get Started +--- + + +Este proyecto es una solución front-end lista para producción para interfaces de administración. Está basado en [Vue](https://vuejs.org/), [Nuxt](https://nuxt.com/) y utiliza el kit de interfaz de usuario [Element Plus](https://element-plus.org/). + +## 🛠 Primeros pasos + +::: code-tabs#shell + +@tab npm + +```bash +# Clonar el Projecto +git clone https://github.com/adempiere/adempiere-vue.git + +# Instalar las Dependencia +npm install + +# Modo Desarrollo +npm run dev + +# Modo Producción +npm run build +``` + +@tab yarn + +```bash +# Clonar el Projecto +git clone https://github.com/adempiere/adempiere-vue.git + +# Instalar las Dependencia +yarm + +# Modo Desarrollo +yarm run dev + +# Modo Producción +yarm run build +``` +::: diff --git a/docs/es/guide/README.md b/docs/es/guide/README.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/get-started/README.md b/docs/get-started/README.md new file mode 100644 index 0000000..9b31836 --- /dev/null +++ b/docs/get-started/README.md @@ -0,0 +1,61 @@ +--- +title: Get Started +icon: signs-post +star: true +sticky: 10 +dir: + order: 1 +category: + - Cookbook + - Tutorial + - Get Started +--- + +```component VPBanner +title: Step-by-step tutorial +content: This section is for newcomers which is not familiar with Frontend, Vue or VuePress.
If you already have experience with them, get started with guide. +background: var(--bg-10) +color: var(--banner-text) +actions: + - text: Guide + link: ../guide/intro/intro.html +``` + +This project is a production-ready front-end solution for administration interfaces. It is based on [Vue](https://vuejs.org/), [Nuxt](https://nuxt.com/) and use the UI Toolkit [Element Plus](https://element-plus.org/) UI kit. + +## 🛠 Getting Started + +::: code-tabs#shell + +@tab npm + +```bash +# Clone the Project +git clone https://github.com/adempiere/adempiere-vue.git + +# Install Dependency +npm install + +# Development +npm run dev + +# Builds +npm run build +``` + +@tab yarn + +```bash +# Clone the Project +git clone https://github.com/adempiere/adempiere-vue.git + +# Install Dependency +yarm + +# Development +yarm run dev + +# Builds +yarm run build +``` +::: diff --git a/docs/intro.md b/docs/intro.md new file mode 100644 index 0000000..5caabf2 --- /dev/null +++ b/docs/intro.md @@ -0,0 +1,8 @@ +--- +icon: circle-info +cover: /assets/images/cover3.jpg +--- + +# Intro Page + +Place your introduction and profile here. diff --git a/docs/zh/README.md b/docs/zh/README.md new file mode 100644 index 0000000..fa63272 --- /dev/null +++ b/docs/zh/README.md @@ -0,0 +1,48 @@ +--- +home: true +layout: BlogHome +icon: home +title: 博客主页 +heroImage: https://theme-hope-assets.vuejs.press/logo.svg +heroText: 你博客的名称 +heroFullScreen: true +tagline: 你可以在这里放置你的口号与标语 +projects: + - icon: project + name: 项目名称 + desc: 项目详细描述 + link: https://你的项目链接 + + - icon: link + name: 链接名称 + desc: 链接详细描述 + link: https://链接地址 + + - icon: book + name: 书籍名称 + desc: 书籍详细描述 + link: https://你的书籍链接 + + - icon: article + name: 文章名称 + desc: 文章详细描述 + link: https://你的文章链接 + + - icon: friend + name: 伙伴名称 + desc: 伙伴详细介绍 + link: https://你的伙伴链接 + + - icon: https://theme-hope-assets.vuejs.press/logo.svg + name: 自定义项目 + desc: 自定义详细介绍 + link: https://你的自定义链接 + +footer: 自定义你的页脚文字 +--- + +这是一个博客主页的案例。 + +要使用此布局，你应该在页面前端设置 `layout: BlogHome` 和 `home: true`。 + +相关配置文档请见 [博客主页](https://theme-hope.vuejs.press/zh/guide/blog/home/)。 diff --git a/docs/zh/demo/README.md b/docs/zh/demo/README.md new file mode 100644 index 0000000..31ede9b --- /dev/null +++ b/docs/zh/demo/README.md @@ -0,0 +1,9 @@ +--- +title: 主要功能与配置演示 +index: false +icon: laptop-code +category: + - 使用指南 +--- + + diff --git a/docs/zh/demo/disable.md b/docs/zh/demo/disable.md new file mode 100644 index 0000000..ff54b57 --- /dev/null +++ b/docs/zh/demo/disable.md @@ -0,0 +1,42 @@ +--- +title: 布局与功能禁用 +icon: gears +order: 4 +category: + - 使用指南 +tag: + - 禁用 + +navbar: false +sidebar: false + +breadcrumb: false +pageInfo: false +contributors: false +editLink: false +lastUpdated: false +prev: false +next: false +comment: false +footer: false + +backtotop: false +--- + +你可以通过设置页面的 Frontmatter，在页面禁用功能与布局。 + + + +本页面就是一个示例，禁用了如下功能: + +- 导航栏 +- 侧边栏 +- 路径导航 +- 页面信息 +- 贡献者 +- 编辑此页链接 +- 更新时间 +- 上一篇/下一篇 链接 +- 评论 +- 页脚 +- 返回顶部按钮 diff --git a/docs/zh/demo/encrypt.md b/docs/zh/demo/encrypt.md new file mode 100644 index 0000000..20d8d23 --- /dev/null +++ b/docs/zh/demo/encrypt.md @@ -0,0 +1,15 @@ +--- +icon: lock +category: + - 使用指南 +tag: + - 加密 +--- + +# 密码加密的文章 + +实际的文章内容。 + +段落 1 文字段落 1 文字段落 1 文字段落 1 文字段落 1 文字段落 1 文字段落 1 文字段落 1 文字段落 1 文字段落 1 文字段落 1 文字段落 1 文字。 + +段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字段落 2 文字。 diff --git a/docs/zh/demo/layout.md b/docs/zh/demo/layout.md new file mode 100644 index 0000000..b89b60a --- /dev/null +++ b/docs/zh/demo/layout.md @@ -0,0 +1,31 @@ +--- +title: 布局 +icon: object-group +order: 2 +category: + - 指南 +tag: + - 布局 +--- + +布局包括: + +- [导航栏](https://theme-hope.vuejs.press/zh/guide/layout/navbar.html) +- [侧边栏](https://theme-hope.vuejs.press/zh/guide/layout/sidebar.html) +- [页脚](https://theme-hope.vuejs.press/zh/guide/layout/footer.html) + +同时每个页面包含: + +- [路径导航](https://theme-hope.vuejs.press/zh/guide/layout/breadcrumb.html) +- [标题和页面信息](https://theme-hope.vuejs.press/zh/guide/feature/page-info.html) +- [TOC (文章标题列表)](https://theme-hope.vuejs.press/zh/guide/layout/page.html#标题列表) +- [贡献者、更新时间等页面元信息](https://theme-hope.vuejs.press/guide/feature/meta.html) +- [评论](https://theme-hope.vuejs.press/zh/guide/feature/comment.html) + +主题也带有以下元素: + +- [夜间模式按钮](https://theme-hope.vuejs.press/zh/guide/interface/darkmode.html) +- [返回顶部按钮](https://theme-hope.vuejs.press/guide/interface/others.html#返回顶部按钮) +- [打印按钮](https://theme-hope.vuejs.press/guide/interface/others.html#打印按钮) + +你可以在主题选项和页面的 frontmatter 中自定义它们。 diff --git a/docs/zh/demo/markdown.md b/docs/zh/demo/markdown.md new file mode 100644 index 0000000..dd4e7c0 --- /dev/null +++ b/docs/zh/demo/markdown.md @@ -0,0 +1,269 @@ +--- +title: Markdown 展示 +icon: fab fa-markdown +order: 2 +category: + - 使用指南 +tag: + - Markdown +--- + +VuePress 主要从 Markdown 文件生成页面。因此，你可以使用它轻松生成文档或博客站点。 + +你应该创建和编写 Markdown 文件，以便 VuePress 可以根据文件结构将它们转换为不同的页面。 + + + +## Markdown 介绍 + +如果你是一个新手，还不会编写 Markdown，请先阅读 [Markdown 介绍](https://theme-hope.vuejs.press/zh/cookbook/markdown/) 和 [Markdown 演示](https://theme-hope.vuejs.press/zh/cookbook/markdown/demo.html)。 + +## Markdown 配置 + +VuePress 通过 Frontmatter 为每个 Markdown 页面引入配置。 + +::: info + +Frontmatter 是 VuePress 中很重要的一个概念，如果你不了解它，你需要阅读 [Frontmatter 介绍](https://theme-hope.vuejs.press/zh/cookbook/vuepress/page.html#front-matter)。 + +::: + +## Markdown 扩展 + +VuePress 会使用 [markdown-it](https://github.com/markdown-it/markdown-it) 来解析 Markdown 内容，因此可以借助于 markdown-it 插件来实现 [语法扩展](https://github.com/markdown-it/markdown-it#syntax-extensions) 。 + +### VuePress 扩展 + +为了丰富文档写作，VuePress 对 Markdown 语法进行了扩展。 + +关于这些扩展，请阅读 [VuePress 中的 Markdown 扩展](https://theme-hope.vuejs.press/zh/cookbook/vuepress/markdown.html)。 + +### 主题扩展 + +通过 [`vuepress-plugin-md-enhance`][md-enhance]，主题扩展了更多 Markdown 语法，提供更加丰富的写作功能。 + +#### 提示容器 + +::: v-pre + +安全的在 Markdown 中使用 {{ variable }}。 + +::: + +::: info 自定义标题 + +信息容器，包含 `代码` 与 [链接](#提示容器)。 + +```js +const a = 1; +``` + +::: + +::: tip 自定义标题 + +提示容器 + +::: + +::: warning 自定义标题 + +警告容器 + +::: + +::: caution 自定义标题 + +危险容器 + +::: + +::: details 自定义标题 + +详情容器 + +::: + +- [查看详情](https://theme-hope.vuejs.press/zh/guide/markdown/hint.html) + +#### 代码块 + +::: code-tabs + +@tab pnpm + +```bash +pnpm add -D vuepress-theme-hope +``` + +@tab yarn + +```bash +yarn add -D vuepress-theme-hope +``` + +@tab:active npm + +```bash +npm i -D vuepress-theme-hope +``` + +::: + +- [查看详情](https://theme-hope.vuejs.press/zh/guide/markdown/code-tabs.html) + +#### 上下角标 + +19^th^ H~2~O + +- [查看详情](https://theme-hope.vuejs.press/zh/guide/markdown/sup-sub.html) + +#### 自定义对齐 + +::: center + +我是居中的 + +::: + +::: right + +我在右对齐 + +::: + +- [查看详情](https://theme-hope.vuejs.press/zh/guide/markdown/align.html) + +#### Attrs + +一个拥有 ID 的 **单词**{#word}。 + +- [查看详情](https://theme-hope.vuejs.press/zh/guide/markdown/attrs.html) + +#### 脚注 + +此文字有脚注[^first]. + +[^first]: 这是脚注内容 + +- [查看详情](https://theme-hope.vuejs.press/zh/guide/markdown/footnote.html) + +#### 标记 + +你可以标记 ==重要的内容== 。 + +- [查看详情](https://theme-hope.vuejs.press/zh/guide/markdown/mark.html) + +#### 任务列表 + +- [x] 计划 1 +- [ ] 计划 2 + +- [查看详情](https://theme-hope.vuejs.press/zh/guide/markdown/tasklist.html) + +### 图片增强 + +支持为图片设置颜色模式和大小 + +- [查看详情](https://theme-hope.vuejs.press/zh/guide/markdown/image.html) + +#### 组件 + +```component VPCard +title: Mr.Hope +desc: Where there is light, there is hope +logo: https://mister-hope.com/logo.svg +link: https://mister-hope.com +background: rgba(253, 230, 138, 0.15) +``` + +- [查看详情](https://theme-hope.vuejs.press/zh/guide/markdown/component.html) + +#### 导入文件 + + + +- [查看详情](https://theme-hope.vuejs.press/zh/guide/markdown/include.html) + +#### 样式化 + +向 Mr.Hope 捐赠一杯咖啡。 _Recommended_ + +- [查看详情](https://theme-hope.vuejs.press/zh/guide/markdown/stylize.html) + +#### Tex 语法 + +$$ +\frac {\partial^r} {\partial \omega^r} \left(\frac {y^{\omega}} {\omega}\right) += \left(\frac {y^{\omega}} {\omega}\right) \left\{(\log y)^r + \sum_{i=1}^r \frac {(-1)^i r \cdots (r-i+1) (\log y)^{r-i}} {\omega^i} \right\} +$$ + +- [查看详情](https://theme-hope.vuejs.press/zh/guide/markdown/tex.html) + +#### 图表 + +