Notationは、開発者がMarkdown形式で書いたドキュメントを簡単にNotionに公開できるAIツールです。このツールを使用することで、ドキュメントの管理が効率化され、コードとドキュメントを同じリポジトリ内で管理することが可能になります。Notationの設計哲学は、ドキュメントがコードと共に存在し、コードの変更に伴ってドキュメントも更新されるべきだという考えに基づいています。
Notationを使用するには、まずNotionのAPIキーを取得し、それを設定ファイルに記述します。その後、Markdownで書かれたドキュメントを指定のコマンドでNotionに公開します。Notion上では、AIを活用した検索機能や美しいフォーマット、目次などが利用可能です。
Notationは、ドキュメントを内部のNotionワークスペースに限定して公開することも、公開ウェブサイトとしてデプロイすることも可能です。さらに、特定のMarkdownファイルを親ページに直接表示する機能や、ページタイトルやアイコンを指定する機能など、便利な追加機能も提供しています。
Notationは、Markdownの基本的な機能(見出し、段落、コードブロック、リスト、テーブル、リンク、画像など)をサポートしており、任意のディレクトリ構造をNotionのサブページとして反映することができます。設定は、Notationバイナリと同じディレクトリに配置するNotation.toml
ファイルで行います。
Notationを使用することで、開発者はドキュメントの作成と管理を効率化し、チームメンバーや非エンジニアのユーザーに対して、常に最新の情報を提供することができます。