feat: publicize doc implemetation

Author: Justineo

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

.eslintrc.js

@@ -0,0 +1,69 @@
+// http://eslint.org/docs/user-guide/configuring
+
+module.exports = {
+  root: true,
+  parserOptions: {
+    parser: 'babel-eslint',
+    sourceType: 'module'
+  },
+  extends: [
+    // https://github.com/vuejs/eslint-plugin-vue#bulb-rules
+    'plugin:vue/essential',
+    'plugin:vue/recommended',
+    'plugin:vue/strongly-recommended',
+    // https://github.com/standard/standard/blob/master/docs/RULES-en.md
+    'standard',
+    'prettier/standard'
+  ],
+  // required to lint *.vue files
+  plugins: ['vue'],
+  // add your custom rules here
+  rules: {
+    // allow paren-less arrow functions
+    'arrow-parens': 0,
+    // allow async-await
+    'generator-star-spacing': 0,
+    // allow debugger during development
+    'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,
+    'no-multi-spaces': ['error', { ignoreEOLComments: true }],
+    'no-template-curly-in-string': 0,
+    // to many false positives
+    'vue/no-side-effects-in-computed-properties': 0,
+    // fix unused var error for JSX custom tags
+    'vue/jsx-uses-vars': 2,
+    'vue/require-default-prop': 0,
+    'vue/name-property-casing': ['error', 'kebab-case'],
+    'vue/component-name-in-template-casing': ['error', 'kebab-case'],
+    'vue/html-indent': [
+      'error',
+      2,
+      {
+        attribute: 1,
+        baseIndent: 0,
+        closeBracket: 0,
+        alignAttributesVertically: true
+      }
+    ],
+    'vue/html-self-closing': [
+      'error',
+      {
+        html: {
+          void: 'never',
+          normal: 'always',
+          component: 'always'
+        },
+        svg: 'always',
+        math: 'always'
+      }
+    ],
+    'vue/html-closing-bracket-spacing': [
+      'error',
+      {
+        startTag: 'never',
+        endTag: 'never',
+        selfClosingTag: 'never'
+      }
+    ],
+    'vue/no-v-html': 0
+  }
+}

.gitignore

@@ -0,0 +1,12 @@
+node_modules
+npm-debug.log
+one/build/deps.json
+.DS_Store
+.nuxt
+.vscode
+pages
+components/demos
+dist
+logs
+assets/data
+static/images/mermaid

README.md

@@ -0,0 +1,124 @@
+# veui/docs
+
+> VEUI 文档。
+
+## 本地安装
+
+`git clone` 到本地后，在项目根目录下运行：
+
+```shell
+npm i
+npm run dev
+```
+
+后在浏览访问 `http://localhost:3000` 即可。
+
+## 文档编写
+
+开发相关文档位于 `one/docs/development` 下。文档目录结构与网站的目录结构一致，新建 `.md` 文件后需要在 `one/docs/nav.json` 中新建相应的条目，作为目录配置。添加 `sub: true` 将缩进一个层级。
+
+### 组件文档结构
+
+每个组件的文档请按如下顺序编写：
+
+1. 示例
+2. API
+
+  1. 属性
+  2. 插槽
+  3. 作用域插槽
+  4. 事件
+  5. 方法
+
+3. 全局配置
+
+  1. `veui` 中的默认
+  2. `veui-theme-dls` 中的默认配置
+
+4. 图标名称
+
+另外，如有关联组件请在最开始进行说明。比如：
+
+```md
+:::tip
+`Select` 组件可以内联 [`Option`](./option) 或 [`OptionGroup`](./option-group) 组件使用。
+:::
+```
+
+### 在文档中插入示例
+
+使用 Markdown 的 shortcode 语法，如下：
+
+```md
+[[ demo src="../demo/button.vue"]]
+```
+
+路径为 demo 文件相对于当前文档文件的路径。Demo 文件是一个 Vue 单文件组件，最后会将代码展示到文档中。可以编写多个 `<style>` 块，如果带上自定义的 `docs` 属性，则会从文档的源码中去除，用来写一些不想输出到文档里的样式（建议文档里只展示和演示的用法相关的样式代码）。
+
+可以为 demo 书写内嵌的说明，方法为在 demo 文件中增加 `<docs>` 自定义块，比如：
+
+```html
+<docs>
+具体内容请参考项目 [repo](https://github.com/ecomfe/veui)。
+</docs>
+```
+
+### 扩展 Markdown 语法
+
+#### 自定义块
+
+因为 Markdown 原生不支持对特定区块设定自定义的 `class`，直接书写 HTML 标签的话内部的内容就无法直接写 Markdown 了。故扩展了如下自定义块的语法：
+
+```md
+:::tip
+这是一条小贴士。
+:::
+```
+
+将会渲染为：
+
+```html
+<div class="tip custom-block">这是一条小贴士。</div>
+```
+
+目前支持的状态类型有 `tip`/`warning`/`alert`。
+
+标注 `v-model` 及 `.sync` 的属性/事件请使用如下格式：
+
+```md
+:::badges
+`v-model`
+:::
+```
+
+#### 内联引用
+
+Markdown 中书写表格比较麻烦，如果想在里面嵌入格式比较复杂的内容，原生语法 + GFM 扩展都是不够用的。这里提供了一个定义可被引用内容+将对应内容块内联到文档内任意位置的语法。
+
+定义可被引用的内容：
+
+```md
+^^^ui
+内容
+^^^
+```
+
+引用方式和脚注的引用方式相同，只是会将内容直接嵌入当前位置：
+
+```md
+[^ui]
+```
+
+#### 可折叠区块
+
+有时内容过长不利于阅读全文，故扩展了如下语法支持默认收起的区块，可点击展开。
+
+```md
++++摘要内容
+详细内容
++++
+```
+
+## 文案规范
+
+参见[《中文文案排版指北》](https://github.com/sparanoid/chinese-copywriting-guidelines)。

app.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html {{ HTML_ATTRS }}>
+  <head>
+    {{ HEAD }}
+  </head>
+  <body {{ BODY_ATTRS }}>
+    {{ APP }}
+  </body>
+</html>

app.js

@@ -0,0 +1,43 @@
+const express = require('express')
+const nuxt = require('nuxt')
+const { Nuxt, Builder } = nuxt
+
+const app = express()
+const host = process.env.HOST || '127.0.0.1'
+const port = process.env.PORT || 8080
+
+// uncaughtException 避免程序崩溃
+process.on('uncaughtException', function (err) {
+  console.error(err)
+  try {
+    let killTimer = setTimeout(function () {
+      process.exit(1)
+    }, 10000)
+    killTimer.unref()
+    server.close()
+  } catch (e) {
+    console.error('Fail to close server safely. ', e.stack)
+  }
+})
+
+app.set('port', port)
+
+// Import and Set Nuxt.js options
+const config = require('./nuxt.config.js')
+config.dev = !(process.env.NODE_ENV === 'production')
+
+// Init Nuxt.js
+const server = new Nuxt(config)
+
+// Build only in dev mode
+if (config.dev) {
+  const builder = new Builder(server)
+  builder.build()
+}
+
+// Give nuxt middleware to express
+app.use(server.render)
+
+// Listen the server
+app.listen(port, host)
+console.log('Server listening on ' + host + ':' + port) // eslint-disable-line no-console

app/router.scrollBehavior.js

@@ -0,0 +1,23 @@
+export default function scrollBehavior (to) {
+  // if the returned position is falsy or an empty object,
+  // will retain current scroll position.
+  let position = false
+
+  // if no children detected
+  if (to.matched.length < 2) {
+    // scroll to the top of the page
+    position = { x: 0, y: 0 }
+  } else if (
+    to.matched.some(r => r.components.default.options.scrollToTop)
+  ) {
+    // if one of the children has scrollToTop option set to true
+    position = { x: 0, y: 0 }
+  } else if (
+    to.hash &&
+    document.querySelector(decodeURIComponent(to.hash))
+  ) {
+    // scroll to anchor by returning the selector
+    position = { selector: to.hash }
+  }
+  return position
+}

assets/README.md

@@ -0,0 +1,8 @@
+# ASSETS
+
+This directory contains your un-compiled assets such as LESS, SASS, or JavaScript.
+
+More information about the usage of this directory in the documentation:
+https://nuxtjs.org/guide/assets#webpacked
+
+**This directory is not required, you can delete it if you don't want to use it.**