textlintのスターターキットです。 このリポジトリーに含んでいるのは、textlint本体とそのプラグインのみです。
別途Node.jsのインストールが必要です。
Node.jsは特にこだわりがなければStable版をインストールします。
Node.jsをインストールしている方は、zipファイルをダウンロードまたはgit clone後にインストールしてtextlintを使えるようにします。
Gitに慣れていない方向けのインストール方法です。
Releasesから最新版をダウンロードしてください。 その後zipを展開します。展開したらそのディレクトリー配下にあるファイルやディレクトリーを適当なところにコピー&ペーストします。
Gitを使いこなせる方向けのインストール方法です。
ターミナルや任意のGitを扱えるソフトウェアなどで次のコマンドを実行してください。
git clone https://github.com/kubosho/textlint-starter-kit.git
cd textlint-starter-kit
npm installテキストエディターとしてAtomを使う場合は、拡張パッケージのインストールをすることで、ターミナルなどの操作なくtextlintを使うことができます。 インストールする拡張パッケージは次の2つです。
これらをインストールすれば、Atom上からtextlintが使えるようになり、とても便利です。 拡張パッケージのインストールについては、次のリンクを参考にしてください。
いずれの説明も、前提はtextlint-starter-kitをインストールしたディレクトリー上にsrcディレクトリーがあることです。
- Atomと前述のAtom拡張パッケージをインストールした方は、
srcディレクトリーにテキストやマークダウンファイルを追加することで、文章の自動校正がおこなえます。 - Atomを使っていないかたは、ターミナルなどで次のコマンドを実行します。このコマンドで
srcディレクトリー以下にある文書へ対し、textlintが実行されます。
npm start- フォークします
- 任意の名前でブランチを作ります：
git checkout -b my-new-feature - 変更した点をコミットします：
git commit -am 'Add some feature' - ブランチをリモートへプッシュします：
git push origin my-new-feature - Pull Requestしましょう :D
MIT License