nb-public

公開ノートブック（テンプレート）です

クイックリンク

“nb” とは何か

概念: 3層構造のプレーンテキスト・ノートブック

nb（xwmx / nb が提供する nb コマンド）は、コマンドラインとローカル Web のノートブック・ブックマーク・アーカイブ・知識ベースアプリケーションです。その本質は次の3層構造にあります。

層 役割 実体
データ層 ノート本体 素の Markdown ファイル（= プレーンテキスト）
バックエンド層 バージョン管理と同期 Git リポジトリ
レンダリング層 表示と変換 Pandoc / ローカル Web（browse）

大事なのは「データがツールに依存しない」ことです。ノートはただの .md ファイルなので、将来どれだけ nb やサービスが変わってもデータはそのまま残り、他のツールにも容易に移行できます。”nb” はこのプレーンなデータに対して Git と Pandoc を透過的に組み合わせることで、ノートブックに「書く・貯める・探す・変換する・同期する」機能をまとめて与えています。

特徴

他ツールとの比較

  nb Notion Obsidian Joplin
操作環境 ターミナル & Web アプリ/ブラウザ アプリ/Web デスクトップ/モバイル
データ形式 素の Markdown 独自データベース Markdown Markdown
同期 Git ネイティブ クラウド依存 拡張依存 クラウド/WebDAV
ローカル/オフライン フル対応 限定的 概ね対応 対応
CLI 連携 強力 ほとんど不可 制限あり 一部
学習コスト 中（シェル慣れ必須） 低 低 低

日常的にターミナル上で作業している人なら、起動の速さ、キーボード操作中心、スクリプトとの相性のよさから、「案外 nb は使い勝手が良い」と感じられます。

ユースケース

このリポジトリそのものが、「nb を GitHub 同期して公開ノートとして運用する」実例です。

PKMツールとしての”nb”

Notion, Obsidian, Joplin … どれも優れたツールです。それらの登場によって日陰者になった感のあるツールが “nb” です。

でも日常的にターミナルを使う人ならば、話は違います。案外 “nb” は使い勝手が良かったりします。AI が生成する大量のテキストを「整理」を気にせずにただ貯めておけるからです。もちろん取り出しも容易です。

ちょっと触ってちょっと慣れたら、”nb” が好きになるかもしれませんよ。ということで、このリポジトリを備忘を兼ねて作成することにしました。どうかお試しください。

nbでコンテンツ（xxx.md）を作成します

nbコマンドでモートリポジトリにコンテンツをプッシュするには以下の手順に従ってください：

  1. リモートリポジトリを設定する: ノートブックのリモートURLを設定します。

     nb remote set https://github.com/yourusername/your-repo

  2. 変更をプッシュする: ローカルノートブックをリモートリポジトリと同期し、新しいまたは更新されたコンテンツをプッシュします。

     nb sync --remote origin
    • このコマンドは自動的に変更をコミットし、リモートにプッシュします。
    • 複数のノートブックがある場合、ノートブックを指定してください: nb example:sync

Git同期とリモート管理の詳細については、nbドキュメントを参照してください。

参考：

ファイルの配置

.nb-public
├── README.md
└── docs
    └── index.md（このファイル）
    └── xxx.md（このファイルからのリンク先）
    └── yyy.md（このファイルからのリンク先）
    └── zzz.md（このファイルからのリンク先）

docs/内が web となります。 nb-public直下に.md（ファイル）を保存してください。 GitHubのリポジトリにプッシュ（nb sync --remote origin）するだけでワークフローによってwebが生成されます。 -> 「公開ノート」

GitHub Pagesについては、公式ドキュメントを参照してください。

初回発行: 2025年11月1日 最終更新: 2026年8月9日