コンテンツにスキップ

PCC-DocsLink

このドキュメントです。

編集したい場合Link

github.com/PCCSuiteに加入していない場合、GitHubアカウントを作成してアカウント名をサーバー管理者に送りつけてください。

加入したら、編集してプルリクエストを送信してください。

構文Link

基本的にはMarkDownなので、markdownでググってください。
こちらのサイトにMkDocs固有の構文が紹介されています。

警告文の使い分けLink

このドキュメントでは警告文を以下のように使い分けています。構文も一応載せておきます。

Note

メモです。一応の付け足しなどにお使いください

!!!note
    メモです。一応の付け足しなどにお使いください

F**K

独り言です。心残り、本音など余計なことを書いておきましょう。
何かの役に立つかもしれません

!!!note "F\*\*K"
    独り言です。心残り、本音など余計なことを書いておきましょう。  
    何かの役に立つかもしれません

For administrator

サーバー管理者に対しての事項などをメモしたり、その説明があるページに誘導するために利用します。

!!!note "For administrator"
    サーバー管理者に対しての事項などをメモしたり、その説明があるページに誘導するために利用します。

Warning

警告です。行うべき・行ってはいけない動作を書いておきます。
例外的に書きかけの記事を識別するのにも使用できます。

!!!warning
    警告です。行うべき・行ってはいけない動作を書いておきます。  
    例外的に書きかけの記事を識別するのにも使用できます。

Danger

セキュリティ脆弱性やデータ破損が発生する可能性のある動作である場合、Warningよりこちらを使用します。

!!!danger
    セキュリティ脆弱性やデータ破損が発生する可能性のある動作である場合、Warningよりこちらを使用します。

Important

この警告文の下に記述されてる内容を実行するにあたり、何か行う必要があることを書いておきます。
特に重要なものは警告文の見出しに書きましょう

!!!important
    この警告文の下に記述されてる内容を実行するにあたり、何か行う必要があることを書いておきます。  
    特に重要なものは警告文の見出しに書きましょう

Hint

躓きやすそうなポイントをあらかじめ警告するのに用います
tipが利用されている場合、こちらに修正をお願いします。

!!!hint
    躓きやすそうなポイントをあらかじめ警告するのに用います  
    tipが利用されている場合、こちらに修正をお願いします。

Todo

やりたかったけどできなかったこと、これからすることについて書きます

!!!todo
    やりたかったけどできなかったこと、これからすることについて書きます

Bug

これからすることがバグ関連であるときは、todoよりこちらを使用します。
また、報告されている不具合についてもこの警告文で記述します。

!!!bug
    これからすることがバグ関連であるときは、todoよりこちらを使用します。  
    また、報告されている不具合についてもこの警告文で記述します。

AのときXを実行

プログラム動作などを説明するとき、成功となる動作を説明します

Bの時Yを実行

プログラム動作などを説明するとき、失敗となる動作(エラーなど)を説明します

CのときZを実行

プログラム動作などを説明するとき、成功でも失敗でもない例外動作について説明します

!!!success "AのときXを実行"
    プログラム動作などを説明するとき、成功となる動作を説明します

!!!fail "Bの時Yを実行"
    プログラム動作などを説明するとき、失敗となる動作(エラーなど)を説明します

!!!info "CのときZを実行"
    プログラム動作などを説明するとき、成功でも失敗でもない例外動作について説明します

リンクについてLink

Docs内ページへのリンクは、リンク切れを防止するため・Typoraでの編集をしやすくするために原則設置しません。
他のページを参照させたい場合、"ページ名"の頁をご覧くださいなどと記入して誘導してください。

外部ページへのリンクの貼り付けはOKです。

画像についてLink

画像は、mdファイルが配置されているフォルダに存在するimagesフォルダから参照するようにしてください。

Hint

例えば、/docs/client/Login Window.mdに画像を載せたいとき、画像は/docs/client/images/内に配置します

拡張子の大文字・小文字は区別されますので気を付けてください(例：png/PNG/Png)

Danger

特にペイントやSnippingToolでのデフォルト拡張子は大文字です。気を付けてください！

一人称の禁止Link

「私」の代わりに、期生・役職を明記するようにしてください(例：8期サーバー管理者)

編集データをプレビューするLink

先ほどgit cloneしたディレクトリ(deploy.shが存在するフォルダ)をコマンドプロンプトのカレントディレクトリにした状態で、以下を入力します。

mkdocs serve

この状態で、ブラウザで以下のページにアクセスするとプレビューを見ることができます。 

http://127.0.0.1:8000