Comment PR

.env

@@ -0,0 +1,2 @@
+VITE_FEEDBACK_URL=https://164.92.190.45/feedback/form
+VITE_COMPAT_MATRIX_URL=https://docs-compat.iroha2.tachi.soramitsu.co.jp/compat-matrix

.eslintignore

@@ -0,0 +1,3 @@
+.vitepress/dist
+.vitepress/cache
+src/snippets

.eslintrc.js

@@ -1,15 +1,29 @@
+// eslint-disable-next-line no-undef
 module.exports = {
-    extends: ['plugin:vue'],
-    // env: {
-    //     es2021: true,
-    // },
-    rules: {
-        'spaced-comment': [
-            'error',
-            'always',
-            {
-                markers: ['/'],
-            },
-        ],
+  root: true,
+  extends: ['plugin:vue/vue3-recommended', 'eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+  parser: 'vue-eslint-parser',
+  parserOptions: {
+    parser: '@typescript-eslint/parser',
+    sourceType: 'module',
+  },
+  rules: {
+    'vue/html-indent': ['error', 2],
+    'spaced-comment': [
+      'error',
+      'always',
+      {
+        markers: ['/'],
+      },
+    ],
+  },
+  overrides: [
+    {
+      files: ['.vitepress/theme/components/MermaidRender.vue'],
+      rules: {
+        // FIXME: find a way to disable this it for the particular line
+        'vue/no-v-html': 'off',
+      },
     },
+  ],
 }

.github/CODEOWNERS

@@ -0,0 +1,14 @@
+*   @outoftardis
+
+# doc sources
+/src/   @outoftardis @WRRicht3r @nxsaken
+*.md    @outoftardis @WRRicht3r @nxsaken
+src/guide/javascript.md @0x009922 @outoftardis @WRRicht3r @nxsaken
+
+# configurations
+/.vitepress/   @0x009922
+*.js    @0x009922
+*.ts    @0x009922
+*.json  @0x009922
+*.yaml  @0x009922
+*.vue   @0x009922

.github/workflows/gh-pages-deploy.yaml

@@ -0,0 +1,68 @@
+name: Deploy at GitHub Pages
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      # --- Install with caching
+      # https://github.com/pnpm/action-setup#use-cache-to-reduce-installation-time
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        run: |
+          echo "::set-output name=pnpm_cache_dir::$(pnpm store path)"
+
+      - uses: actions/cache@v3
+        name: Setup pnpm cache
+        with:
+          path: |
+            ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }}
+            /home/runner/.cache/Cypress
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install packages
+        run: pnpm install
+
+      - name: Check formatting
+        run: pnpm format:check
+
+      - name: Run linter
+        run: pnpm lint
+
+      - name: Run tests
+        run: pnpm test
+
+      - name: Build VitePress
+        run: |
+          pnpm build
+          pnpm cli validate-links .vitepress/dist --public-path $PUBLIC_PATH
+        env:
+          PUBLIC_PATH: /iroha-2-docs/
+          # chalk has a color detection bug
+          FORCE_COLOR: 2
+
+      - name: Push static content into master:gh-pages
+        working-directory: .vitepress/dist
+        run: |
+          git config --global user.email "${GITHUB_ACTOR}@https://users.noreply.github.com/"
+          git config --global user.name "${GITHUB_ACTOR}"
+          git init
+          git add --all
+          git commit -m "Auto update pages on $(date +'%Y-%m-%d %H:%M:%S')"
+          git push -f -q https://git:${{ secrets.github_token }}@github.com/${{ github.repository }} master:gh-pages

.github/workflows/pull-request-ci.yaml

@@ -0,0 +1,58 @@
+name: Pull Request CI
+on:
+  pull_request:
+    branches: [main]
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      # --- Install with caching
+      # https://github.com/pnpm/action-setup#use-cache-to-reduce-installation-time
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        run: |
+          echo "pnpm_cache_dir=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v3
+        name: Setup pnpm cache
+        with:
+          path: |
+            ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }}
+            /home/runner/.cache/Cypress
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install packages
+        run: pnpm install
+
+      - name: Type check
+        run: pnpm typecheck
+
+      - name: Lint
+        run: pnpm lint
+
+      - name: Format
+        run: pnpm format:check
+
+      - name: Run tests
+        run: pnpm test
+
+      - name: Build
+        run: pnpm build
+
+      - name: Validate links
+        run: pnpm cli validate-links .vitepress/dist
+        env:
+          # chalk has a color detection bug
+          FORCE_COLOR: 2

.gitignore

@@ -1,2 +1,9 @@
+.DS_Store
 node_modules
 dist
+/src/flymd.md
+/src/flymd.html
+/src/*.temp
+/src/snippets
+.vitepress/cache
+.idea

.npmrc

@@ -0,0 +1 @@
+@iroha2:registry=https://nexus.iroha.tech/repository/npm-group/

.prettierignore

@@ -0,0 +1,4 @@
+.vitepress/dist
+.vitepress/cache
+/src/snippets
+/src/example_code

.prettierrc.js

@@ -1,39 +1,32 @@
+// eslint-disable-next-line no-undef
 module.exports = {
-    // max 120 characters per line
-    printWidth: 120,
-    // use 24spaces for indentation
-    tabWidth: 4,
-    // use spaces instead of indentations
-    useTabs: false,
-    // semicolon at the end of the line
-    semi: false,
-    // use single quotes
-    singleQuote: true,
-    // object's key is quoted only when necessary
-    quoteProps: 'as-needed',
-    // use double quotes instead of single quotes in jsx
-    jsxSingleQuote: false,
-    // no comma at the end
-    trailingComma: 'all',
-    // spaces are required at the beginning and end of the braces
-    bracketSpacing: true,
-    // brackets are required for arrow function parameter, even when there is only one parameter
-    arrowParens: 'always',
-    // format the entire contents of the file
-    rangeStart: 0,
-    rangeEnd: Infinity,
-    // no need to write the beginning @prettier of the file
-    requirePragma: false,
-    // No need to automatically insert @prettier at the beginning of the file
-    insertPragma: false,
-    // use default break criteria
-    proseWrap: 'preserve',
-    // decide whether to break the html according to the display style
-    htmlWhitespaceSensitivity: 'css',
-    // vue files script and style tags indentation
-    vueIndentScriptAndStyle: false,
-    // lf for newline
-    endOfLine: 'lf',
-    // formats quoted code embedded
-    embeddedLanguageFormatting: 'auto',
+  printWidth: 120,
+  tabWidth: 2,
+  useTabs: false,
+  semi: false,
+  singleQuote: true,
+  quoteProps: 'as-needed',
+  jsxSingleQuote: false,
+  trailingComma: 'all',
+  bracketSpacing: true,
+  arrowParens: 'always',
+  rangeStart: 0,
+  rangeEnd: Infinity,
+  requirePragma: false,
+  insertPragma: false,
+  proseWrap: 'preserve',
+  htmlWhitespaceSensitivity: 'css',
+  vueIndentScriptAndStyle: false,
+  endOfLine: 'lf',
+  embeddedLanguageFormatting: 'auto',
+
+  overrides: [
+    {
+      files: ['./src/**/*.md'],
+      options: {
+        printWidth: 75,
+        proseWrap: 'always',
+      },
+    },
+  ],
 }