Cosense Toolbox のドキュメント

Cosense のページを解析・公開したり、エディターで快適に書いたりするためのツール群です。

ヘッダの検索 (⌘K / Ctrl+K) では、パッケージ名や機能名、本文の言葉からガイドを探せます。

Cosense の記法を解析して、自分のアプリで使いたい場合は Cosense 記法パーサー から始めてください。

.csn / .csnx でサイトやブログを書きたい場合は、コンパイラーの Cosense X と、Astro を使う場合の Astro 統合 をご覧ください。

変換したページの見た目を整えるには 既定のスタイル または Tailwind CSS を使えます。

.csn / .csnx をエディターで書く場合は、VS Code 拡張、Zed 拡張、または Language Server と TextMate 文法 を組み合わせてください。

Cosense 記法パーサー (@cosense-toolbox/parser) は、位置情報つき AST の生成、走査、HTML や独自形式への変換を担当します。

Cosense X (@cosense-toolbox/cosense-x) は、Cosense 記法のページを JSX モジュールへコンパイルします。

Astro 統合 (@cosense-toolbox/astro) は、.csn / .csnx を Astro のページと content collection で使えるようにします。

既定のスタイル (@cosense-toolbox/style) は、パーサーが出力する HTML の既定 CSS です。

Tailwind CSS (@cosense-toolbox/tailwind) は、Tailwind CSS から同じスタイルを使うプラグインです。

TextMate 文法 (@cosense-toolbox/textmate) は、.csn / .csnx の TextMate 文法です。

Language Server (@cosense-toolbox/lsp) は、補完・定義ジャンプ・リンク診断を提供します。

VS Code 拡張 と Zed 拡張 は、エディターでこれらを使うためのアプリです。

Astro ブログの実例 では、記事・タグ・リンクグラフを組み合わせています。

npm に公開しているライブラリは beta です。利用前に各パッケージの README と変更履歴を確認し、必要に応じてバージョンを固定してください。

Cosense (旧 Scrapbox) の非公式プロジェクトです。Helpfeel 社とは関係がなく、公認も受けていません。各パッケージは MIT ライセンスで公開しています。