
2026/04/15 20:29
Show HN: SmallDocs – フラストレーションのない Markdown の導入方法
RSS: https://news.ycombinator.com/rss
要約▶
Japanese Translation:
SmallDocs は、コマンドラインエージェントが生成する
.md ファイルの閲覧と共有における課題を解決するために作られた、プライバシーを最優先とした CLI および Web アプリケーションツールです。100% のローカル制御でマダックファイルを即座にプレビューして共有できるように設計されています。 sdocs-dev をインストールすると、 sdoc path/to/file.md を実行することでブラウザ上でファイルを開くことができ、本ツールは単なるクライアントサイドレンダリングエンジンとして機能します。コンテンツは URL フラグメント内に圧縮された Base64 データとして保存されるため、デバイス外へ送出されず、リモートサーバーとも接しません。ユーザーは各ファイルの YAML Front Matter の先頭で複雑なスタイルやグラフのレンダリングを指定でき、共有された URL に沿ってセキュリティを保ったままスタイルと可視化データを安全に伝搬させることができます。SmallDocs は、ローカルエージェントファイル(例: ~/.claude/CLAUDE.md または ~/.codex/AGENTS.md )に構成行を追加してエージェントワークフローへの統合を促しており、CLI の初期使用時にこれらの行を自動追加するためのオプションのセットアップフェーズも用意されています。 sdoc schema や sdoc charts といったコマンドでさらなる機能や冒険的な例題にアクセスでき、ドキュメントの詳細は CLI を介して入手可能です。今後の展望として、SmallDocs はプリスタイルされた文書の安全な共有を簡素化し、将来のワークフローにおけるマダックコンテンツのレンダリング方法を変革することを目標としています。本文
こんにちは、HN の方々。SmallDocs (https://sdocs.dev) をご紹介します。SDocs は、コマンドラインインターフェース(CLI)とウェブアプリケーションを組み合わせたツールで、マークダウンファイルの内容を瞬時に、かつ完全にプライベートな形でエレガントにプレビューおよび共有可能にします。(ソースコード:GitHub リポジトリ)
コマンドラインベースのエージェントとの作業が増えるに従って、
.md ファイルは私たちの日常業務の一部になりつつあります。エージェントによる出力としては優れていますが見る方(人間)にとっては少々不便で、プレビューや共有・受領がやや面倒な面があります。SDocs はこうした課題を解決することを目的として開発されました。
まず
npm i -g sdocs-dev でグローバルにインストールした後、以下のようにコマンドを実行すると、ブラウザで即座にプレビュー表示されます(見た目にも心地よいデフォルトスタイルを適用済み)。
sdoc path/to/file.md
さらに、生成された URL は瞬時に共有可能です。
私たちのエージェントが生成する
.md ファイルには、コードベースに関する情報や未解決のバグ、本番環境のログなど、極めて機微な情報が含まれています。そのため、SDocs では「100% のプライバシー」を必須要件として位置づけています。
このために、SDocs の URL フラグメント(# の直後の部分)に、圧縮された Base64 エンコード形式でマークダウンドキュメントの内容が埋め込まれています。 例:
https://sdocs.dev/#md=GzcFAMT...(この部分は文書内容そのものです)。
URL フラグメントの優れた点は、サーバーには送信されないという事実にあります(Mozilla のドキュメントをご覧ください:「フラグメントは URI を要求する際にサーバーへ送られず、クライアント側で処理される」)。
sdocs.dev のウェブアプリは、単に URL フラグメントに格納されたコンテンツをクライアント側でデコードしてレンダリングするエンジンに過ぎません。つまり、ドキュメントの内容はあなた自身と、共有先を選択した相手の方の側に留まり、SDocs サーバーは一切アクセスすることなく扱われます。(ご自身の環境で、あるいはエージェントから当社のコードを検証してみていただければ、これは容易に確認できます)
.md ファイルは今後の働き方において大きな役割を果たす可能性を秘めているため、SDocs はマークダウン形式でのコンテンツの表示やスタイル付けにおける境界線を押し広げたいと考えています。まだ多くの作業が残されていますが、まずは複雑なスタイルを追加したり、チャートを可視化してレンダリングしたりといった機能を既に実装しています。SDocs のルートディレクトリにある sdoc.md をデフォルトスタイルで表示するページには、冒険的な試みに関するいくつかの画像とリンクを掲載しています。「sdoc schema」と「sdoc charts」コマンドは、SDocs フォーマティングを最大限に活用するための詳細な情報をご提供します。
また、共有された SDocs URL に合わせてスタイルが同行するのは、マークダウンファイルに Jekyll ドキュメント方式に基づく YAML フロントマターとしてスタイル設定を追加しているためです(例:https://jekyllrb.com/docs/front-matter/)。
--- styles: fontFamily: Lora baseFontSize: 17 ... ---
業務の現場では、実際にこのプロジェクトのテストを行っています。私とチームメンバーは、SDocs をエージェントによるデバッグレポートの共有や、Claude から容易にコピペ可能なコンテンツ(例えば一連の実行が必要なバッチコマンドなど)を取得する手段として非常に有用だと感じています。
また、私たちのエージェントが SDocs を積極的に利用できるよう促すため、ルートディレクトリの「エージェントファイル」(例:
~/.claude/CLAUDE.md や ~/.codex/AGENTS.md など)に数行の指示文を追加しています。CLI を初めて使用する際に、この設定作業を支援するためのオプションセットアップフェーズを用意しています。
もちろん、皆様からのフィードバックは大いに歓迎しており、SDocs に機能を追加したいという方はプルリクエストを大歓迎します。
ご覧いただけたことをありがとうございます!