make run
🔖 グローバル環境を可能な限り汚染せずにMarkdownから組版のPDFを生成(ゆめみ大技林 '23)
書籍のタイトルの設定などは、book/vivliostyle.config.js ファイルで行います。
またテンプレートの都合上、年号等が最新に設定できないため、<!-- -->
でコメントアウトしています。必要に応じて修正してコメントアウトを外してください。
- book/manuscripts ディレクトリの中に、拡張子
.md
のMarkdownファイルを作成します。 - book/vivliostyle.config.js ファイル内の
entry
配列に、そのMarkdownファイル名を追加します。
校正ツール textlint を利用して、文章校正ができます。なお、この lint ツールの使用は任意です。書き方で悩んだ・校正したい場合など、必要に応じて導入してください。
次のルールを導入しています。
- preset-ja-spacing
- 日本語周りにおけるスペースの有無を決定する
- preset-ja-technical-writing
- 技術文書向けの textlint ルールプリセット
- textlint-rule-spellcheck-tech-word
- WEB+DB 用語統一ルールベースの単語チェック
- (deprecated になっているので置き換えたい)
- Rules for TechBooster
- TechBooster の ルール を使用しています。
- iOS に関するルールはほとんどないので適宜追加してください。
その他、スペルチェックのルール textlint-rule-spellchecker
がありますが、エディターのスペルチェックと競合しやすいので、今回は追加していません。VS Code を利用している場合は、プラグイン Code Spell Checker を追加すれば、スペルチェックが行われます。
make lint
VS Code にプラグイン Dev Containers を追加します。コマンドパレット(ショートカットキー Command + Shift + P)を開いて、Remote-Containers: Reopen in Container
を実行します。コンテナーが立ち上がったら、執筆を始めてください。ファイル保存時に textlint が自動実行されます。
あるファイルを textlint の対象から外したい場合は .textlintignore
にそのファイルを追加してください。また、ファイル内の特定の文章に対してルールを無効にしたい場合は、次のように記述してください。
<!-- textlint-disable -->
textlint を無効にしたい文章をここに書く
<!-- textlint-enable -->
ローカル環境に Node.js がインストールされている場合は、Docker を使わずにビルドできます。
次のコマンドで、ビルドに必要なツールをローカル環境にインストールします。
npm install
プレス版の PDF をビルドするには、Ghostscript も必要になります。次のコマンドでインストールします。
brew install ghostscript
npm run start
: pdfを生成して開く(make run
相当)npm run lint
: textlintを実行(make lint
相当)npm run build
: pdfを生成(make pdf
相当)npm run build:press
: プレス版のpdfを生成(make pdf_press
相当)npm run open
: pdfを開く(make open
相当)npm run clean
: 生成ファイルをすべて削除(make clean
相当)