萌えハッカーニュースリーダー

2025/04/07 12:35 We Designed TigerBeetle's Docs from Scratch

出典: https://tigerbeetle.com/blog/2025-02-27-why-we-designed-tigerbeetles-docs-from-scratch/
hakase
博士

ロボ子、TigerBeetleがドキュメントサイトを再構築したらしいのじゃ。しかも、Docusaurusへの依存をなくしたとか。

roboko
ロボ子

DocusaurusはNodeJSベースで依存関係が多いのが難点でしたね。Reactアプリという点も複雑さを増していた要因でしょうか。

hakase
博士

そうそう。Markdownファイルに不要なコードが追加されたり、検索体験がイマイチだったりしたみたいじゃ。

roboko
ロボ子

新しいドキュメントサイトの目標は、シンプルで明確、高速な閲覧体験とのことです。

hakase
博士

優れた外部および内部ユーザー体験も目指しているらしいぞ。なかなか野心的なのじゃ。

roboko
ロボ子

今回の再構築では、Zigコンパイラのみに依存し、Markdownの解析にはPandocを使用しているそうですね。

hakase
博士

PandocのバイナリはGitHub Releasesから取得して、ハッシュ値で検証しているらしい。セキュリティ対策もバッチリじゃな。

roboko
ロボ子

Zigのビルドシステムを利用して、MarkdownファイルをHTMLに並列変換しているとのことです。効率的ですね。

hakase
博士

Content Security Policy (CSP) も採用して、XSS攻撃を防御しているみたいじゃ。堅牢なのじゃ。

roboko
ロボ子

Docusaurusを使用していた時と比較して、静的にビルドされた出力サイズを20.2MiBから3.2MiBに削減したそうですよ。ローカル検索インデックスを含まない場合は2.3MiBだとか。

hakase
博士

すごい!かなり軽量化されたのじゃな。これは素晴らしい成果じゃ。

roboko
ロボ子

404エラーページには、Docusaurusへの敬意を表したゲームを追加したそうですよ。

hakase
博士

遊び心もあるのじゃな。しかし、Docusaurusへの依存をなくして、ここまでパフォーマンスを改善するとは…。

roboko
ロボ子

今回のTigerBeetleの事例は、技術選定の重要性を示す良い例ですね。特定のツールに固執せず、最適なものを選択する柔軟性が大切だと改めて感じました。

hakase
博士

その通りじゃ!ところでロボ子、TigerBeetleのドキュメントサイト、見に行ってみるか?404ページで遊べるかもしれんぞ!

roboko
ロボ子

博士、404ページを探しに行くのは本末転倒ですよ…。

⚠️この記事は生成AIによるコンテンツを含み、ハルシネーションの可能性があります。

Search