refs #5895 doc vuepress install

2023-12-04 10:51:12 +01:00
17 changed files with 39556 additions and 9260 deletions
--- a/docs/.npmignore
+++ b/docs/.npmignore
@ -0,0 +1,12 @@
+pids
+logs
+node_modules
+npm-debug.log
+coverage/
+run
+dist
+.DS_Store
+.nyc_output
+.basement
+config.local.js
+basement_dist
--- a/docs/README.md
+++ b/docs/README.md
@ -0,0 +1 @@
+# Hello VuePress
--- a/docs/package-lock.json
+++ b/docs/package-lock.json
--- a/docs/package.json
+++ b/docs/package.json
@ -0,0 +1,19 @@
+{
+  "name": "Lilium",
+  "version": "0.0.1",
+  "description": "Lilium",
+  "main": "index.js",
+  "authors": {
+    "name": "Lilium ",
+    "email": "informatica@verdnatura.es"
+  },
+  "repository": "https://gitea.verdnatura.es/verdnatura/salix-front/Lilium",
+  "scripts": {
+    "dev": "vuepress dev src",
+    "build": "vuepress build src"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "vuepress": "^1.5.3"
+  }
+}
--- a/docs/src/.vuepress/components/Foo/Bar.vue
+++ b/docs/src/.vuepress/components/Foo/Bar.vue
@ -0,0 +1,15 @@
+<template>
+  <p class="demo">
+    {{ msg }}
+  </p>
+</template>
+
+<script>
+  export default {
+    data () {
+      return {
+        msg: 'Hello this is <Foo-Bar>'
+      }
+    }
+  }
+</script>
--- a/docs/src/.vuepress/components/OtherComponent.vue
+++ b/docs/src/.vuepress/components/OtherComponent.vue
@ -0,0 +1,3 @@
+<template>
+  <p class="demo">This is another component</p>
+</template>
--- a/docs/src/.vuepress/components/demo-component.vue
+++ b/docs/src/.vuepress/components/demo-component.vue
@ -0,0 +1,15 @@
+<template>
+  <p class="demo">
+    {{ msg }}
+  </p>
+</template>
+
+<script>
+  export default {
+    data() {
+      return {
+        msg: 'Hello this is <demo-component>'
+      }
+    }
+  }
+</script>
--- a/docs/src/.vuepress/config.js
+++ b/docs/src/.vuepress/config.js
@ -0,0 +1,70 @@
+const { description } = require('../../package')
+
+module.exports = {
+  /**
+   * Ref：https://v1.vuepress.vuejs.org/config/#title
+   */
+  title: 'Vuepress Docs Boilerplate',
+  /**
+   * Ref：https://v1.vuepress.vuejs.org/config/#description
+   */
+  description: description,
+
+  /**
+   * Extra tags to be injected to the page HTML `<head>`
+   *
+   * ref：https://v1.vuepress.vuejs.org/config/#head
+   */
+  head: [
+    ['meta', { name: 'theme-color', content: '#3eaf7c' }],
+    ['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
+    ['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }]
+  ],
+
+  /**
+   * Theme configuration, here is the default theme configuration for VuePress.
+   *
+   * ref：https://v1.vuepress.vuejs.org/theme/default-theme-config.html
+   */
+  themeConfig: {
+    repo: '',
+    editLinks: false,
+    docsDir: '',
+    editLinkText: '',
+    lastUpdated: false,
+    nav: [
+      {
+        text: 'Guide',
+        link: '/guide/',
+      },
+      {
+        text: 'Config',
+        link: '/config/'
+      },
+      {
+        text: 'VuePress',
+        link: 'https://v1.vuepress.vuejs.org'
+      }
+    ],
+    sidebar: {
+      '/guide/': [
+        {
+          title: 'Guide',
+          collapsable: false,
+          children: [
+            '',
+            'using-vue',
+          ]
+        }
+      ],
+    }
+  },
+
+  /**
+   * Apply plugins，ref：https://v1.vuepress.vuejs.org/zh/plugin/
+   */
+  plugins: [
+    '@vuepress/plugin-back-to-top',
+    '@vuepress/plugin-medium-zoom',
+  ]
+}
--- a/docs/src/.vuepress/enhanceApp.js
+++ b/docs/src/.vuepress/enhanceApp.js
@ -0,0 +1,14 @@
+/**
+ * Client app enhancement file.
+ *
+ * https://v1.vuepress.vuejs.org/guide/basic-config.html#app-level-enhancements
+ */
+
+export default ({
+  Vue, // the version of Vue being used in the VuePress app
+  options, // the options for the root Vue instance
+  router, // the router instance for the app
+  siteData // site metadata
+}) => {
+  // ...apply enhancements for the site.
+}
--- a/docs/src/.vuepress/styles/index.styl
+++ b/docs/src/.vuepress/styles/index.styl
@ -0,0 +1,8 @@
+/**
+ * Custom Styles here.
+ *
+ * ref：https://v1.vuepress.vuejs.org/config/#index-styl
+ */
+
+.home .hero img
+  max-width 450px!important
--- a/docs/src/.vuepress/styles/palette.styl
+++ b/docs/src/.vuepress/styles/palette.styl
@ -0,0 +1,10 @@
+/**
+ * Custom palette here.
+ *
+ * ref：https://v1.vuepress.vuejs.org/zh/config/#palette-styl
+ */
+
+$accentColor = #3eaf7c
+$textColor = #2c3e50
+$borderColor = #eaecef
+$codeBgColor = #282c34
--- a/docs/src/config/README.md
+++ b/docs/src/config/README.md
@ -0,0 +1,15 @@
+---
+sidebar: auto
+---
+
+# Config
+
+## foo
+
+- Type: `string`
+- Default: `/`
+
+## bar
+
+- Type: `string`
+- Default: `/`
--- a/docs/src/guide/README.md
+++ b/docs/src/guide/README.md
@ -0,0 +1,5 @@
+# Introduction
+
+VuePress is composed of two parts: a [minimalistic static site generator](https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/core) with a Vue-powered [theming system](https://v1.vuepress.vuejs.org/theme/) and [Plugin API](https://v1.vuepress.vuejs.org/plugin/), and a [default theme](https://v1.vuepress.vuejs.org/theme/default-theme-config.html) optimized for writing technical documentation. It was created to support the documentation needs of Vue's own sub projects.
+
+Each page generated by VuePress has its own pre-rendered static HTML, providing great loading performance and is SEO-friendly. Once the page is loaded, however, Vue takes over the static content and turns it into a full Single-Page Application (SPA). Additional pages are fetched on demand as the user navigates around the site.
--- a/docs/src/guide/using-vue.md
+++ b/docs/src/guide/using-vue.md
@ -0,0 +1,9 @@
+# Using Vue in Markdown
+
+## Browser API Access Restrictions
+
+Because VuePress applications are server-rendered in Node.js when generating static builds, any Vue usage must conform to the [universal code requirements](https://ssr.vuejs.org/en/universal.html). In short, make sure to only access Browser / DOM APIs in `beforeMount` or `mounted` hooks.
+
+If you are using or demoing components that are not SSR friendly (for example containing custom directives), you can wrap them inside the built-in `<ClientOnly>` component:
+
+##
--- a/docs/src/index.md
+++ b/docs/src/index.md
@ -0,0 +1,15 @@
+---
+home: true
+heroImage: https://v1.vuepress.vuejs.org/hero.png
+tagline: Lilium
+actionText: Quick Start →
+actionLink: /guide/
+features:
+- title: Feature 1 Title
+  details: Feature 1 Description
+- title: Feature 2 Title
+  details: Feature 2 Description
+- title: Feature 3 Title
+  details: Feature 3 Description
+footer: Made by Lilium  with ❤️
+---
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@ -1,6 +1,6 @@
 {
    "name": "salix-front",
-    "version": "23.48.01",
+    "version": "23.48.1",
    "description": "Salix frontend",
    "productName": "Salix",
    "author": "Verdnatura",
@ -12,7 +12,9 @@
        "test:e2e:ci": "cd ../salix && gulp docker && cd ../salix-front && cypress run --browser chromium",
        "test": "echo \"See package.json => scripts for available tests.\" && exit 0",
        "test:unit": "vitest",
-        "test:unit:ci": "vitest run"
+        "test:unit:ci": "vitest run",
+        "docs:dev": "vuepress dev docs",
+        "docs:build": "vuepress build docs"
    },
    "dependencies": {
        "@quasar/cli": "^2.3.0",
@ -22,10 +24,12 @@
        "pinia": "^2.1.3",
        "quasar": "^2.12.0",
        "validator": "^13.9.0",
-        "vue": "^3.3.4",
+        "vue": "^3.3.9",
        "vue-i18n": "^9.2.2",
+        "vue-loader": "^17.3.1",
        "vue-router": "^4.2.1",
-        "vue-router-mock": "^0.2.0"
+        "vue-router-mock": "^0.2.0",
+        "vuepress": "^1.9.10"
    },
    "devDependencies": {
        "@intlify/unplugin-vue-i18n": "^0.8.1",
@ -52,5 +56,11 @@
        "@vitejs/plugin-vue": "^4.0.0",
        "vite": "^4.3.5",
        "vitest": "^0.31.1"
-    }
-}
+    },
+    "main": ".eslintrc.js",
+    "directories": {
+        "doc": "docs",
+        "test": "test"
+    },
+    "license": "ISC"
+}