これはなにか
Contentfulで管理している記事の本文を、VSCodeを使ってMarkdownで快適に執筆するためのツールです。
2023.01.03 追記
Goで書き直しました。
なんで作った?
Contentfulのダッシュボード上でもMarkdownでの執筆はできるようになっています。
他のCMSに比べるとかなり使いや すいのではないかな?
とはいえエディタでLintやFormatterを設定して執筆する快適さには勝てるわけがない。
ということでContentfulでデータは管理するけど、必要なときに記事本文だけ取得して、編集したら反映するツールを作りました。
できること
大まかなことはGitHubのREADMEに書いています。
CLIツール
コマンドを実行することで、下記が瞬時に実行できます。
- 記事の取得
- 複数件(100件まで)
- 指定したIDを1件
- 記事の更新
- ローカルに取得している記事情報の参照
エディタ
VSCodeと拡張機能で快適に設定できます。
- Markdownルール(Lint)のカスタマイズ
- MarkdownのリアルタイムPreview
- Markdownの入力補助
- Markdownのオートフォーマット
- 各種ショートカットキーによる操作
出来ることの詳細はmarkdownlintとMarkdown All in Oneでググってください。
ツールの実装について
軽くどんな実装をしたか紹介しておきます。
scripts
ディレクトリ配下にCLIツールの処理を格納しています。
JavaScript(Node.js)で記述していて、Contentfulとの通信はContent Management APIを扱うためのSDKであるcontentful-management.jsを使っています。
おわり
興味あれば自分好みに設定いじって使ってください。