ライティングラボ by Shodo

執筆・ライティングについてのノウハウを共有するブログです。 ブログや本の執筆、コンテンツマーケティングにお役立てください!

Shodoでディレクトリー以下のMarkdownを一気に校正する方法

Shodoのコマンドラインツールを使えばお手元のターミナルでShodoのAI校正を利用できます。
今回は簡単な使い方の紹介と、ディレクトリー以下のMarkdownファイルを一括で校正する方法を説明します。

インストール方法

pip を使ってインストールしてください。

$ pip install shodo

インストールできれば、次に shodo login コマンドでログインしましょう。

$ shodo login

認証用のトークンを発行する方法はこちらをご覧ください

コマンドからMarkdownの文書を校正する

shodo lint コマンドを使ってローカルのMarkdownファイルを校正できます。

$ shodo lint README.md

以下のように位置と修正の提案が表示されます。

Linting...
3:11 もしかして:変換ミス
     飛行機の欠便があり、運行(→ 運航)状況が変わった。 バ
6:5 もしかして:タイプミス
     ません。  これが私で(→ での)自己紹介です。  こ

ディレクトリー以下のMarkdownファイルを一気に校正する

以下のコマンドで、カレントディレクトリー以下にあるすべての *.md ファイルを校正します。

find . -name "*.md" -print -exec shodo lint {} \;

このコマンドの各オプションの意味は以下のとおりです:

  • find . -name "*.md":現在のディレクトリ(.)以下にある、拡張子が.mdのファイルを検索します
  • -print:見つかったファイル名を表示します
  • -exec shodo lint {} \;:見つかった各ファイルに対して、shodo lintコマンドを実行します

これでディレクトリー以下のMarkdownファイルを一気に校正できました。

詳しい使い方はShodoの開発者ドキュメントを参照してください。

おわりに

現在、Shodoではアドベントカレンダー応援クーポンを配布しております。80%オフでShodoを最長3ヶ月間使えるクーポンです。以下のクーポンコードをご購入時に入力して、このアドベントカレンダーの季節にShodoのAI校正をブログの執筆にお役立てください。

XMAS2024

執筆:@hirokiky、レビュー:@hirokiky
Shodoで執筆されました