2017-12-02 02:04:52 -08:00
|
|
|
|
# コントリビュート
|
|
|
|
|
|
|
|
|
|
|
|
コントリビュート方法及びガイドラインです。
|
|
|
|
|
|
|
|
|
|
|
|
- [commit方法について](#commit方法について)
|
|
|
|
|
|
- [Markdownの構文について](#markdownの構文について)
|
|
|
|
|
|
- [目次の追加](#目次の追加)
|
|
|
|
|
|
- [ページ更新日について](#ページ更新日について)
|
|
|
|
|
|
- [YAML Front Matterで利用できる独自のパラメータについて](#yaml-front-matterで利用できる独自のパラメータについて)
|
|
|
|
|
|
- [Modリスト/ツールリスト/テクスチャパック/サブゲーム/配布マップの追加方法について](#modリストツールリストテクスチャパックサブゲーム配布マップの追加方法について)
|
|
|
|
|
|
- [修正の提案、TODOについて](#修正の提案todoについて)
|
|
|
|
|
|
- [紹介する動画について](#紹介する動画について)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## commit方法について
|
|
|
|
|
|
|
|
|
|
|
|
Forkしたリポジトリからpull requestを行ってください。
|
|
|
|
|
|
|
|
|
|
|
|
[minetest-jp](https://github.com/minetest-jp)のメンバーであれば直接commitすることも可能です。
|
|
|
|
|
|
|
|
|
|
|
|
## Markdownの構文について
|
|
|
|
|
|
|
2017-12-02 06:08:50 -08:00
|
|
|
|
基本的にはGithub風のMarkdown構文が使用できます。
|
2017-12-02 02:04:52 -08:00
|
|
|
|
|
|
|
|
|
|
ただし、以下のような違いがあります。
|
|
|
|
|
|
|
|
|
|
|
|
- Markdownの改行はHTMLの改行コード(`<br />`)に変換されます。
|
|
|
|
|
|
- GithubのMarkdownと違い、空白行を入れなくても改行可能です。
|
2017-12-02 06:10:17 -08:00
|
|
|
|
- (そのためGithub上では正しく表示されない場合があります)
|
2017-12-02 06:08:50 -08:00
|
|
|
|
- Markdown要素内にHTMLコードを書いても適用されます。
|
|
|
|
|
|
- 例えば、コードブロック(\`\`\`~\`\`\`)内に書いた場合もHTMLコードとして認識されます。
|
2017-12-02 02:04:52 -08:00
|
|
|
|
|
|
|
|
|
|
## 目次の追加
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
- toc
|
|
|
|
|
|
{:toc}
|
|
|
|
|
|
```
|
|
|
|
|
|
目次を追加する場合は以上のコードを挿入してください。
|
|
|
|
|
|
|
|
|
|
|
|
## ページ更新日について
|
|
|
|
|
|
|
|
|
|
|
|
ページ更新の際はYAML Front Matterにdate(更新日)を書いていただけるとありがたいです。
|
|
|
|
|
|
YAML Front Matterで利用できる独自パラメータについては後述します。
|
|
|
|
|
|
|
|
|
|
|
|
## YAML Front Matterで利用できる独自のパラメータについて
|
|
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
<dt>date</dt>
|
|
|
|
|
|
<dd>更新日時です。20XX-XX-XXのように記述します。</dd>
|
|
|
|
|
|
|
|
|
|
|
|
<dt>custom-style</dt>
|
|
|
|
|
|
<dd>追加のCSSです。そのページでのみ使用されるCSSはここに記述します。</dd>
|
|
|
|
|
|
|
|
|
|
|
|
<dt>custom-head</dt>
|
|
|
|
|
|
<dd>追加のヘッダです。そのページでのみ使用されるscriptタグなどはここに記述します。</dd>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
## Modリスト/ツールリスト/テクスチャパック/サブゲーム/配布マップの追加方法について
|
|
|
|
|
|
|
|
|
|
|
|
`_data`内にあるページ名と同名のフォルダにymlファイルを追加します。また、スクリーンショットも`images`内の同名フォルダに追加します。
|
|
|
|
|
|
ファイル名がソートに使用されます。ファイル名にハイフンは使用できません。
|
|
|
|
|
|
|
|
|
|
|
|
書式は以下のとおりです。
|
|
|
|
|
|
```yml
|
|
|
|
|
|
# 名前
|
|
|
|
|
|
name: "Hogehoge Mod"
|
|
|
|
|
|
|
|
|
|
|
|
# 作者名
|
|
|
|
|
|
author: "hogehoger"
|
|
|
|
|
|
|
|
|
|
|
|
# スクリーンショットのパス
|
|
|
|
|
|
# imagesフォルダからのパスを指定します。
|
|
|
|
|
|
screenshot: "/mods-decor/hogehoge.png"
|
|
|
|
|
|
|
|
|
|
|
|
# プラットフォーム名 (ツールのみ使用可能)
|
|
|
|
|
|
platform: "Windows / Linux"
|
|
|
|
|
|
|
|
|
|
|
|
# 説明文
|
|
|
|
|
|
# HTMLコードも使用できます。
|
|
|
|
|
|
description: "hogehogeを追加するMod。"
|
|
|
|
|
|
|
|
|
|
|
|
# 関連リンクリスト
|
|
|
|
|
|
# フォーラムへのリンクやダウンロードリンクなど。
|
|
|
|
|
|
links:
|
|
|
|
|
|
-
|
|
|
|
|
|
text: "フォーラム"
|
|
|
|
|
|
url: "https://forum.minetest.net"
|
|
|
|
|
|
-
|
|
|
|
|
|
text: "ダウンロード"
|
|
|
|
|
|
url: "https://github.com/"
|
|
|
|
|
|
|
|
|
|
|
|
# 依存Modリスト (Modのみ使用可能)
|
|
|
|
|
|
depends:
|
|
|
|
|
|
-
|
|
|
|
|
|
text: "TU-KA Mod"
|
|
|
|
|
|
url: "mods-decor#tu_ka" # もちろんWiki内へのリンクも使用可能です。
|
|
|
|
|
|
-
|
|
|
|
|
|
text: "FooBarMod"
|
|
|
|
|
|
url: "https://forum.minetest.net"
|
|
|
|
|
|
|
|
|
|
|
|
# 連携可能/対応Modリスト (Modのみ使用可能)
|
|
|
|
|
|
depends_optional:
|
|
|
|
|
|
-
|
|
|
|
|
|
text: "Piyopiyo Mod"
|
|
|
|
|
|
url: "mods-decor#piyopiyo"
|
|
|
|
|
|
-
|
|
|
|
|
|
text: "42"
|
|
|
|
|
|
url: "https://forum.minetest.net"
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## 修正の提案、TODOについて
|
|
|
|
|
|
|
|
|
|
|
|
GithubのProjectsにあるTODOリストに追加していただけるとありがたいです。
|
|
|
|
|
|
|
|
|
|
|
|
## 紹介する動画について
|
|
|
|
|
|
|
|
|
|
|
|
動画紹介に載せる動画は許可を取ったもののみでお願いいたします。
|
