Notationについて
Notationは便利なツールです。マークダウンでドキュメンテーションを書き、自動的にNotionに公開できます。
コア機能:
- ドキュメンテーションとリポジトリを分けて管理する必要がない。
- ログインせずにドキュメントを更新できる。
- マークダウンをフロントエンドフレームワークとして使用。
- 非エンジニアでも読めるドキュメントを作成可能。
- 高い検索機能を備える。
- ドキュメンテーションもコードと同じレビュー＆CIプロセスに従う。
基本的な使用方法:
- マークダウンでドキュメンテーションを作成する。
- Notionページを作成してドキュメンテーションをホストする。
- NotionからAPIキーを取得し、~/.notation/Notation.tomlファイルに設定する。
notation ship --src </path/to/you/docs>を実行してNotionにドキュメンテーションを表示する。
デプロイメントオプション:
- チームのためにNotionワークスペース内にドキュメンテーションを保持する。
- Notionページとして公開する。
- super.soなどを使用してフルオンのウェブサイトとしてデプロイする。
追加機能:
intro.mdファイルを使用して、親ページに直接コンテンツを表示できる。- マークダウンファイルの先頭にCLIフラグとして
title（ページのタイトル）とemoji（ページのアイコン）を設定できる。
