【Rust】mdlibで作るMarkdownウィキ

Posted at 2025-04-17

Rustで書かれたノートアプリmdlibが実用性もあり、実装も興味深かったので紹介します。

mdlibは、Rustで書かれたウェブベースのMarkdownノートアプリケーションです。自分のマークダウンファイルを、タグやカテゴリで整理し、リアルタイムプレビューでスムーズに編集できます。現時点では個人用途のみを想定しているようです（チーム機能なし）。

前提条件

GitHub上の説明によると、mdlibには以下のような機能があります：

cargo install mdlib

git clone https://github.com/bahdotsh/mdlib.git
cd mdlib

cargo build --release

コンパイルされたバイナリはtarget/release/mdlibに配置されます。

mdlibを起動するには、以下のコマンドを実行します：

mdlib [DIRECTORY]

[DIRECTORY]はマークダウンファイルを含むディレクトリへのパスです。指定しない場合、現在のディレクトリが使用されます。

カスタム設定ファイルを指定することもできます：

mdlib --config-file /path/to/config.json [DIRECTORY]

起動したら、ブラウザでhttp://localhost:3000にアクセスします。

mdlibには設定を管理するための特別なコマンドが含まれています：

# 設定ファイルの場所と現在の設定を表示
mdlib --config

# デフォルトの設定ファイルを作成
mdlib --config create

# 埋め込まれた静的ファイルを一覧表示（デバッグ用）
mdlib --list-embedded

READMEに記載されているキーボードショートカットは以下の通りです：

--config-fileオプションでカスタム設定ファイルを指定できます：

mdlib --config-file /path/to/config.json

設定オプションには以下が含まれます：

デフォルト設定を持つconfig.jsonファイルの例：

{
  "port": 3000,
  "watch_files": true,
  "bind_address": "127.0.0.1",
  "max_file_size_mb": 10,
  "default_dark_mode": false
}

これらの設定は好みに応じてカスタマイズできます：

GitHub上のソースコードを調査すると、プロジェクト構造は以下のようになっています：

src/: ソースコード
- main.rs: エントリーポイント
- fs.rs: ファイルシステム操作
- server.rs: ウェブサーバーとAPIエンドポイント
- config.rs: 設定管理
- embedded.rs: 埋め込み静的アセットハンドラ
static/: 静的ウェブファイル（コンパイル時にバイナリに埋め込まれる）
- index.html: メインHTMLページ
- css/: スタイルシート
- js/: JavaScriptファイル

ソースコードをみたところ、mdlibはAxumを中心に以下のような技術を使用しています：

mdlibは、シンプルながらも機能的なマークダウンウィキシステムです。Rustで書かれたバックエンドとウェブインターフェースを組み合わせることで、ナレッジベースの管理ツールとして活用できそうです。

インストールは簡単で、既存のマークダウンファイルをそのまま活用できるため、すぐに使い始めることができます。また、Gitリポジトリとしてノートを管理すれば、バージョン管理やバックアップの恩恵も受けられますね。

チーム機能やAPI機能があるとさらに便利になりそうですね