Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 10 commits into from
Feb 18, 2023
4 changes: 4 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"no-inline-html": false,
"line-length": false
}
4 changes: 3 additions & 1 deletion docs/UX・UIデザインの方針.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
## UI/UX デザイン方針
# UI/UX デザイン方針

## 基本方針

メモ程度ですが、VOICEVOX の UX や UI のデザインの設計方針を共有します。

Expand Down
15 changes: 6 additions & 9 deletions docs/フォントについて.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -29,4 +27,3 @@ foreach ($f in gci("./*.ttf")){
woff2_compress.exe "unhinted-$($f.name)"
}
```

11 changes: 10 additions & 1 deletion docs/ミッション・バリュー・ビジョン.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
VOICEVOX のミッションは、 VOICEVOX を通じて音声合成ソフトウェアや音声合成キャラクターをより身近なものにすることです。
# VOICEVOXのミッション・バリュー・ビジョン

## ミッション

VOICEVOX のミッションは、 VOICEVOX を通じて
音声合成ソフトウェアや音声合成キャラクターをより身近なものにすることです。

## バリュー

VOICEVOX のバリューは、ユーザー数・技術力・新規性です。
ユーザー数の増加を最も重視します。企業に負けない技術力を目指します。新しいものを積極的に取り入れます。

## ビジョン

VOICEVOX のビジョンは、日本で最も使われる音声合成ソフトウェアになることです。
6 changes: 3 additions & 3 deletions docs/全体構成.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# 全体構成について

## OSS 版と製品版の違い

オープンソースとして公開されている VOICEVOX(OSS 版 VOICEVOX)と、
Expand All @@ -7,11 +9,9 @@
キャラクターは多くの場合 OSS と相反するライセンスを持っているため、OSS にすることができません。
例えば、キャラクターのライセンスによくある「公序良俗に反する利用の禁止」や「反社会的勢力の排除」は、オープンソースの定義の1つである「利用する分野に対する差別の禁止」と衝突します。

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 -->
Expand Down
3 changes: 2 additions & 1 deletion docs/細かい設計方針.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# 設計に関する詳細方針

## Vuex とダイアログ

ダイアログは外部 API とみなし、Vuex の Store の Action 内から呼ぶことを許容しています。
Expand All @@ -23,4 +25,3 @@ StyleId は現在整数値型になっていますが、将来的にはUuidに
## シングルファイルコンポーネント(SFC、`.vue`ファイル)のtemplate、script、styleの順序

`<template>`、`<script>`、`<style>`の順序で記述してください。

2 changes: 2 additions & 0 deletions public/contact.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# お問い合わせ

Hiroshiba marked this conversation as resolved.
Show resolved Hide resolved
## ご感想・ご要望

ぜひ Twitter にてハッシュタグ `#VOICEVOX` を付けてツイートしてください。開発の励みになります。
Expand Down
Loading