47
Help us understand the problem. What are the problem?

More than 1 year has passed since last update.

Organization

Markdownファイル校正手順 - 実務編

前提

手順

npm のちょっとしたオプションについては以下を参照。

Step.1 本体と最低限のルールをインストール

任意のフォルダを作成。

C:\workspaces\textlint_work

cd C:\workspaces\textlint_work
npm init -y
npm install --save-dev textlint textlint-rule-preset-ja-spacing textlint-rule-preset-ja-technical-writing

上記で、textlint 本体 + プリセット2つをインストールする。

  • preset-ja-spacing
  • preset-ja-technical-writing

npx textlint --init で、.textlintrc が生成される。

Step.2 追加のルールをインストール

上を参考に入れてみる。

npm install --save-dev textlint-rule-preset-smarthr
npm install --save-dev textlint-rule-no-mix-dearu-desumasu

既存の .textlintrc は一旦バックアップを取り、
npx textlint --init で再生成。以下ができる。

{
  "filters": {},
  "rules": {
    "no-mix-dearu-desumasu": true,
    "preset-smarthr": true,
    "preset-ja-spacing": true,
    "preset-ja-technical-writing": true
  }
}

こんな感じです。
image.png

Step.3 VSCodeで校正

C:\workspaces\textlint_work\md 内にMarkdownファイルを置いた。
VSCodeで C:\workspaces\textlint_work のフォルダを開く。

例)
image.png

以上で基本的なものがチェックできますよというメモ。
お役に立てばさいわいです。

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Sign upLogin
47
Help us understand the problem. What are the problem?