CBC Docs

Code-Based Cryptography のドキュメント

このメンバーでないと基本的にPRは受け付けていないのでご了承ください。

概要と進捗状況

環境構築

記事を閲覧 or 執筆するには、Python環境が必要になります。

1. Python の仮想環境を構築する(一回目のみ)

色々ありますが、今回はvenvを紹介します。

まず、venvという名前の仮想環境を構築します。

python -m venv venv

2. 仮想環境に入る

venvという名前の仮想環境を作ったのでそこに入ります。

source ./venv/bin/activate

3. 必要なライブラリをインストールする(一回目のみ)

requirements.txtに必要なライブラリがあるので、それをインストールします。

python -m pip install -r requirements.txt

4. サーバーを起動する

python dev.py

これで、サーバーが起動します。http://localhost:8080で確認できます。

執筆

上の手順でサーバーが起動したら、執筆していきましょう。

./md/以下にマークダウンの作成やドキュメントの登録をしていくことになります。

note

基本的にはこの./md/以下のファイルしか触りません。

1. Markdown を書く

./md/内でマークダウンのファイルを作成します。今回は./md/example.mdとします。

これはマークダウンの例です。必ず**削除**してください。

# チャプター

ここでは例として$1$を二回足したらどうなるかについて考えてみましょう。

## セクション

試してみた。

$$
  1 + 1 = 2
$$

2. 登録する。

ファイルを作成したら、manifest.jsonにドキュメントを登録しましょう。

{
  "docs": [
    {
      "title": "マークダウンの例",
      "path": "example",
      "date": "2020/09/03",
      "author": "YAMADA TAROU"
    },
    // ...(略)...
  ]
}

note

pathには必ずファイル名と同じ文字を入力してください。