ライティングラボ by Shodo

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

ShodoでDocusaurusのドキュメントを校正できる?

皆さん、ドキュメントツールは何を使っていますか? Shodoでは開発ドキュメントにDocusaurusを使っています。Docusaurusはかなりおしゃれに書けますし、React的な書き方でMarkdownを書ける .mdx という機能もあり便利です(なかなかワイルドな仕様ですが)。

Shodoのコマンドを使ってDocusaurusの文章を校正してみましょう!

Shodoのコマンドを使おう

pipでShodoのコマンドをインストールしましょう。

$ pip install shodo

次にShodoで発行したアカウントでログインします。

$ shodo login

準備は以上です!

細かな手順は開発者ドキュメントをご覧ください。

Docusaurusのファイルを校正しよう

Docusaurusの docs/ 以下にあるMarkdownファイルを校正しましょう。今回はShodoの開発者ドキュメントで使っているDocusaurusのプロジェクトで試しています。

shodo lint ...md とMarkdownのファイルを引数に指定してコマンドを実行すれば日本語を校正して結果を表示します。

$ cd docs/gettings-started
$ shodo lint create-shodo-account.md
Linting...
15:61 もしかして:タイプミス
     ックし、Shodoのアカウント(→ アカウントを)作成してください。

校正の結果は標準出力として表示されますので、位置を参考にしつつ修正しましょう。ShodoのAPIは結果を30分ほどキャッシュするので、変更した日本語文のみAPIの利用文字にカウントされます。

またShodoのコマンドは .mdx でもうまく解釈してくれます。

shodo lint programming-shodo-lint-api.mdx
Linting...
151:76 もしかして:タイプミス
     少し時間をおいて再度リクエスト(→ リクエストを)行ってください。

ですのでDocusaurusでもShodoのコマンドを活用して、日本語の文を校正できます。Shodoの校正機能はある程度ゆるくタグやMarkdownを解釈しつつ、日本語を取り出して校正するので .mdx というDocusaurusの特殊なファイルにも対応できています。

結論:Shodoのコマンド・APIは良い感じに日本語文を校正するのでDocusaurusの .mdx ファイルにも対応できる

ちなみにですが、HTMLを校正したいときは shodo lint --html を使ってください。

おわりに

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

XMAS2024

執筆:@hirokiky
Shodoで執筆されました