Markdownファイルのガイドライン適応 (#1213)

Author: nmori

.markdownlint.json

@@ -0,0 +1,5 @@
+{
+    "no-inline-html": false,
+    "line-length": false,
+    "no-duplicate-heading": false
+}

docs/UX・UIデザインの方針.md

@@ -1,4 +1,6 @@
-## UI/UX デザイン方針
+# UI/UX デザイン方針
+
+## 基本方針
 
 メモ程度ですが、VOICEVOX の UX や UI のデザインの設計方針を共有します。
 

docs/フォントについて.md

@@ -2,25 +2,23 @@
 
 VOICEVOX では改変したRounded M+ 1pを使用しています。  
 具体的には、
+
 - ヒント情報の削除
 - ttfからwoff2への変換
 を行っています。
 
 ## 手順
 
-1. [自家製 Rounded M+ とは](http://jikasei.me/font/rounded-mplus/about.html)からRounded M+をダウンロードします。
-
-2. [ttfautohint](https://freetype.org/ttfautohint/)をインストールします。
-> **Note**
-> [ttfautohint-py](https://pypi.org/project/ttfautohint-py/)を使用しました。
-
+1. [自家製 Rounded M+ とは](http://jikasei.me/font/rounded-mplus/about.html)から
+Rounded M+をダウンロードします。
+2. [ttfautohint](https://freetype.org/ttfautohint/)をインストールします。[^longnote]:[ttfautohint-py](https://pypi.org/project/ttfautohint-py/)を使用しました。
 3. [woff2](https://github.com/google/woff2)をビルドします。
-
 4. `rounded-mplus-20150529.7z`から`rounded-mplus-1p-(ウェイト).ttf`を全て`src/fonts`に解凍します。
 5. ttfautohintを使用して、Rounded M+のヒント情報を削除します。名前は`Unhinted Rounded M+ 1p`とします。
 6. woff2を使用して、ttfからwoff2へ変換します。
 
-[#1103](https://github.com/VOICEVOX/voicevox/pull/1103)の作成には以下のスクリプトを使用しました（PowerShell 7.3.1）
+[#1103](https://github.com/VOICEVOX/voicevox/pull/1103)の作成には
+以下のスクリプトを使用しました（PowerShell 7.3.1）
 
 ```pwsh
 # cwd：src/fonts
@@ -29,4 +27,3 @@ foreach ($f in gci("./*.ttf")){
   woff2_compress.exe "unhinted-$($f.name)"
 }
 ```
-

docs/ミッション・バリュー・ビジョン.md

@@ -1,6 +1,15 @@
-VOICEVOX のミッションは、 VOICEVOX を通じて音声合成ソフトウェアや音声合成キャラクターをより身近なものにすることです。
+# VOICEVOXのミッション・バリュー・ビジョン
+
+## ミッション
+
+VOICEVOX のミッションは、 VOICEVOX を通じて
+音声合成ソフトウェアや音声合成キャラクターをより身近なものにすることです。
+
+## バリュー
 
 VOICEVOX のバリューは、ユーザー数・技術力・新規性です。  
 ユーザー数の増加を最も重視します。企業に負けない技術力を目指します。新しいものを積極的に取り入れます。
 
+## ビジョン
+
 VOICEVOX のビジョンは、日本で最も使われる音声合成ソフトウェアになることです。

docs/全体構成.md

@@ -1,3 +1,5 @@
+# 全体構成について
+
 ## OSS 版と製品版の違い
 
 オープンソースとして公開されている VOICEVOX（OSS 版 VOICEVOX）と、
@@ -7,11 +9,9 @@
 キャラクターは多くの場合 OSS と相反するライセンスを持っているため、OSS にすることができません。
 例えば、キャラクターのライセンスによくある「公序良俗に反する利用の禁止」や「反社会的勢力の排除」は、オープンソースの定義の１つである「利用する分野に対する差別の禁止」と衝突します。
 
-The Open Source Definition  
-https://opensource.org/osd
+[The Open Source Definition](https://opensource.org/osd)
 
 そのため VOICEVOX では、キャラクターの要素（声や見た目）を含まない OSS 版と、OSS 版をもとに構築してキャラクターの要素を含めた製品版を分けて開発・配布しています。
-
 <img src="./res/全体構成_OSS版と製品版の違い.svg" width="320">
 <!-- 修正時はエディタ側のドキュメントも要修正 -->
 <!-- https://github.com/VOICEVOX/.github/blob/main/profile/README.md -->

docs/細かい設計方針.md

@@ -1,3 +1,5 @@
+# 設計に関する詳細方針
+
 ## Vuex とダイアログ
 
 ダイアログは外部 API とみなし、Vuex の Store の Action 内から呼ぶことを許容しています。  
@@ -23,4 +25,3 @@ StyleId は現在整数値型になっていますが、将来的にはUuidに
 ## シングルファイルコンポーネント（SFC、`.vue`ファイル）のtemplate、script、styleの順序
 
 `<template>`、`<script>`、`<style>`の順序で記述してください。
-

package.json

@@ -1,110 +1,110 @@
 {
-  "name": "voicevox",
-  "version": "999.999.999",
-  "author": "Hiroshiba Kazuyuki",
-  "private": true,
-  "engines": {
-    "node": ">=16.17.0 <17",
-    "npm": ">=8.11.0 <9"
-  },
-  "scripts": {
-    "serve": "vue-cli-service serve",
-    "build": "vue-cli-service build",
-    "test:unit": "vue-cli-service test:unit",
-    "test-watch:unit": "vue-cli-service test:unit --watch",
-    "test:e2e": "playwright test",
-    "test-watch:e2e": "vue-cli-service test:e2e --watch",
-    "lint": "vue-cli-service lint --no-fix",
-    "typecheck": "tsc --noEmit",
-    "typecheck:vue-tsc": "vue-tsc --noEmit",
-    "markdownlint": "markdownlint *.md",
-    "fmt": "vue-cli-service lint",
-    "electron:build": "vue-cli-service electron:build",
-    "electron:build_pnever": "vue-cli-service electron:build --publish never",
-    "electron:serve": "vue-cli-service electron:serve",
-    "postinstall": "electron-builder install-app-deps",
-    "postuninstall": "electron-builder install-app-deps",
-    "license:generate": "node build/generateLicenses.js",
-    "license:merge": "node build/mergeLicenses.js"
-  },
-  "dependencies": {
-    "@gtm-support/vue-gtm": "1.2.3",
-    "@quasar/extras": "1.10.10",
-    "clone-deep": "4.0.1",
-    "core-js": "3.12.1",
-    "dayjs": "1.10.7",
-    "dotenv": "16.0.0",
-    "electron-log": "4.4.8",
-    "electron-store": "8.1.0",
-    "electron-window-state": "5.0.3",
-    "encoding-japanese": "1.0.30",
-    "glob": "8.0.3",
-    "immer": "9.0.2",
-    "markdown-it": "12.0.4",
-    "move-file": "3.0.0",
-    "multistream": "4.1.0",
-    "quasar": "2.11.3",
-    "semver": "7.3.5",
-    "shlex": "2.1.2",
-    "source-map-support": "0.5.19",
-    "systeminformation": "5.8.0",
-    "tree-kill": "1.2.2",
-    "unzipper": "github:ZJONSSON/node-unzipper#341f258",
-    "uuid": "9.0.0",
-    "vue": "3.2.45",
-    "vue-router": "4.0.8",
-    "vuedraggable": "4.1.0",
-    "vuex": "4.0.2",
-    "zod": "3.20.2",
-    "zod-to-json-schema": "3.20.1"
-  },
-  "devDependencies": {
-    "@openapitools/openapi-generator-cli": "2.3.3",
-    "@playwright/test": "1.23.3",
-    "@types/chai": "4.2.18",
-    "@types/clone-deep": "4.0.1",
-    "@types/electron-devtools-installer": "2.2.2",
-    "@types/encoding-japanese": "1.0.18",
-    "@types/glob": "8.0.0",
-    "@types/markdown-it": "12.2.0",
-    "@types/mocha": "5.2.7",
-    "@types/mousetrap": "1.6.8",
-    "@types/multistream": "4.1.0",
-    "@types/semver": "7.3.9",
-    "@types/unzipper": "0.10.5",
-    "@types/uuid": "8.3.4",
-    "@typescript-eslint/eslint-plugin": "5.38.1",
-    "@typescript-eslint/parser": "5.38.1",
-    "@vue/cli-plugin-babel": "4.5.13",
-    "@vue/cli-plugin-eslint": "5.0.8",
-    "@vue/cli-plugin-router": "4.5.13",
-    "@vue/cli-plugin-typescript": "4.5.19",
-    "@vue/cli-plugin-unit-mocha": "4.5.13",
-    "@vue/cli-plugin-vuex": "4.5.13",
-    "@vue/cli-service": "4.5.13",
-    "@vue/compiler-sfc": "3.2.45",
-    "@vue/eslint-config-prettier": "7.0.0",
-    "@vue/eslint-config-typescript": "11.0.2",
-    "@vue/test-utils": "2.0.0-rc.6",
-    "chai": "4.3.4",
-    "chai-as-promised": "7.1.1",
-    "electron": "20.3.3",
-    "electron-devtools-installer": "3.2.0",
-    "eslint": "8.24.0",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-prettier": "3.4.0",
-    "eslint-plugin-vue": "9.5.1",
-    "license-checker": "25.0.1",
-    "markdownlint": "0.23.1",
-    "markdownlint-cli": "0.28.1",
-    "mousetrap": "1.6.5",
-    "prettier": "2.3.0",
-    "sass": "1.32.13",
-    "sass-loader": "8.0.2",
-    "tmp": "0.2.1",
-    "typescript": "4.8.4",
-    "vue-cli-plugin-electron-builder": "3.0.0-alpha.4",
-    "vue-tsc": "0.40.13",
-    "yargs": "17.2.1"
-  }
-}
+    "name": "voicevox",
+    "version": "999.999.999",
+    "author": "Hiroshiba Kazuyuki",
+    "private": true,
+    "engines": {
+        "node": ">=16.17.0 <17",
+        "npm": ">=8.11.0 <9"
+    },
+    "scripts": {
+        "serve": "vue-cli-service serve",
+        "build": "vue-cli-service build",
+        "test:unit": "vue-cli-service test:unit",
+        "test-watch:unit": "vue-cli-service test:unit --watch",
+        "test:e2e": "playwright test",
+        "test-watch:e2e": "vue-cli-service test:e2e --watch",
+        "lint": "vue-cli-service lint --no-fix",
+        "typecheck": "tsc --noEmit",
+        "typecheck:vue-tsc": "vue-tsc --noEmit",
+        "markdownlint": "markdownlint --ignore node_modules/ --ignore dist/ --ignore dist_electron/ ./",
+        "fmt": "vue-cli-service lint",
+        "electron:build": "vue-cli-service electron:build",
+        "electron:build_pnever": "vue-cli-service electron:build --publish never",
+        "electron:serve": "vue-cli-service electron:serve",
+        "postinstall": "electron-builder install-app-deps",
+        "postuninstall": "electron-builder install-app-deps",
+        "license:generate": "node build/generateLicenses.js",
+        "license:merge": "node build/mergeLicenses.js"
+    },
+    "dependencies": {
+        "@gtm-support/vue-gtm": "1.2.3",
+        "@quasar/extras": "1.10.10",
+        "clone-deep": "4.0.1",
+        "core-js": "3.12.1",
+        "dayjs": "1.10.7",
+        "dotenv": "16.0.0",
+        "electron-log": "4.4.8",
+        "electron-store": "8.1.0",
+        "electron-window-state": "5.0.3",
+        "encoding-japanese": "1.0.30",
+        "glob": "8.0.3",
+        "immer": "9.0.2",
+        "markdown-it": "12.0.4",
+        "move-file": "3.0.0",
+        "multistream": "4.1.0",
+        "quasar": "2.11.3",
+        "semver": "7.3.5",
+        "shlex": "2.1.2",
+        "source-map-support": "0.5.19",
+        "systeminformation": "5.8.0",
+        "tree-kill": "1.2.2",
+        "unzipper": "github:ZJONSSON/node-unzipper#341f258",
+        "uuid": "9.0.0",
+        "vue": "3.2.45",
+        "vue-router": "4.0.8",
+        "vuedraggable": "4.1.0",
+        "vuex": "4.0.2",
+        "zod": "3.20.2",
+        "zod-to-json-schema": "3.20.1"
+    },
+    "devDependencies": {
+        "@openapitools/openapi-generator-cli": "2.3.3",
+        "@playwright/test": "1.23.3",
+        "@types/chai": "4.2.18",
+        "@types/clone-deep": "4.0.1",
+        "@types/electron-devtools-installer": "2.2.2",
+        "@types/encoding-japanese": "1.0.18",
+        "@types/glob": "8.0.0",
+        "@types/markdown-it": "12.2.0",
+        "@types/mocha": "5.2.7",
+        "@types/mousetrap": "1.6.8",
+        "@types/multistream": "4.1.0",
+        "@types/semver": "7.3.9",
+        "@types/unzipper": "0.10.5",
+        "@types/uuid": "8.3.4",
+        "@typescript-eslint/eslint-plugin": "5.38.1",
+        "@typescript-eslint/parser": "5.38.1",
+        "@vue/cli-plugin-babel": "4.5.13",
+        "@vue/cli-plugin-eslint": "5.0.8",
+        "@vue/cli-plugin-router": "4.5.13",
+        "@vue/cli-plugin-typescript": "4.5.19",
+        "@vue/cli-plugin-unit-mocha": "4.5.13",
+        "@vue/cli-plugin-vuex": "4.5.13",
+        "@vue/cli-service": "4.5.13",
+        "@vue/compiler-sfc": "3.2.45",
+        "@vue/eslint-config-prettier": "7.0.0",
+        "@vue/eslint-config-typescript": "11.0.2",
+        "@vue/test-utils": "2.0.0-rc.6",
+        "chai": "4.3.4",
+        "chai-as-promised": "7.1.1",
+        "electron": "20.3.3",
+        "electron-devtools-installer": "3.2.0",
+        "eslint": "8.24.0",
+        "eslint-config-prettier": "8.5.0",
+        "eslint-plugin-prettier": "3.4.0",
+        "eslint-plugin-vue": "9.5.1",
+        "license-checker": "25.0.1",
+        "markdownlint": "0.23.1",
+        "markdownlint-cli": "0.28.1",
+        "mousetrap": "1.6.5",
+        "prettier": "2.3.0",
+        "sass": "1.32.13",
+        "sass-loader": "8.0.2",
+        "tmp": "0.2.1",
+        "typescript": "4.8.4",
+        "vue-cli-plugin-electron-builder": "3.0.0-alpha.4",
+        "vue-tsc": "0.40.13",
+        "yargs": "17.2.1"
+    }
+}

public/contact.md

@@ -1,3 +1,5 @@
+# お問い合わせ
+
 ## ご感想・ご要望
 
 ぜひ Twitter にてハッシュタグ `#VOICEVOX` を付けてツイートしてください。開発の励みになります。