Re:VIEW は、EWB や RD あるいは Wiki に似た簡易フォーマットで記述したテキストファイルを、目的に応じて各種の形式に変換するツールセットです。 平易な文法ながらも、コンピュータ関係のドキュメント作成のための多くの機能を備えており、テキスト、LaTeX、HTML、XML といった形式に変換できます。独自のカスタマイズも簡単です。 review/quickstart.ja.md at master · kmuto/review
Re:VIEW は、EWB や RD あるいは Wiki に似た簡易フォーマットで記述したテキストファイルを、目的に応じて各種の形式に変換するツールセットです。 平易な文法ながらも、コンピュータ関係のドキュメント作成のための多くの機能を備えており、テキスト、LaTeX、HTML、XML といった形式に変換できます。独自のカスタマイズも簡単です。
textlint で textlint-filter-rule-comments を使うとコメント記法で「特定のルールを無視する」範囲を設定できる. github.com しかし textlint-plugin-review と組み合わせて Re:VIEW で textlint-filter-rule-comments を使う場合は <!-- --> ではなく #@# という Re:VIEW のコメント記法を使う必要がある.ポイントはここまで👌 #@# textlint-disable #@# textlint-enable github.com 検証ログ 📄 検証ログを残しておく.まず,今回…
Re:VIEWに挑戦する連載の13回目です。前回の記事はこちらになります。 Re:VIEWフォーマット 前回はインライン命令を使った表記をご紹介しました。さらに色々な表記ができて本格的になりました。 ここまでで大体の機能をご紹介したのですが、基本的な記述方法の説明が未だでした。簡単ですし、以下をご参照頂ければ済むのですが、一応触れておきたいと思います。 github.com 見出し 先頭に1つ以上の「=」を付けることで見出しを設定できます。設定できるレベルは6までです。「=」の後には半角スペースをいれます。 = 章 == 節 === 項 ==== 目 ===== 段 ====== 小段 この様…
Re:VIEWに挑戦する連載の12回目です。前回の記事はこちらになります。 hirocom777.hatenadiary.org まだあるブロック命令 前回は、ブロック命令を使ってリード文、囲み記事、表、ソースリストなどの表記をPDFファイルに挿入してみました。本の記述によく使われる表記方法が簡単に実現できるんですね。 でも、ブロック命令はこれだけではありません。今回も引き続きブロック命令を取り上げていきます。そして併せてインライン命令もご紹介します。 インライン命令 インライン命令は段落、文字列内の一部に対して装飾などの処理を行います。インライン命令の書式は以下の通りです。 @<命令>{対象…
Re:VIEWに挑戦する連載の11回目です。前回の記事はこちらになります。 hirocom777.hatenadiary.org ブロック命令 前回は、PDFファイルに画像データを挿入してみました。画像が入ると一段と本らしくなりますね。 そして図の表示に使用した表記は、ブロック命令と呼ばれるものです。ブロック命令は1〜複数行の段落に対して装飾などの処理を行うもので、図の表示以外にもいろいろあります。今回は、それらをご紹介します。 ブロック命令の書式 ブロック命令の書式は以下の通りです。 //命令[オプション1][オプション2]・・・{ 対象の内容 //} 命令によってはオプション省略できる場合…
Re:VIEWに挑戦する連載の10回目です。前回の記事はこちらになります。 hirocom777.hatenadiary.org 図を表示する 前回は、複数のファイルからRe:VIEWで1つのPDFファイルを作成してみました。結構本格的になってきましたね。 でも、今まで変換、表示してきたのは文字だけ。図の表示がありません。やはり適度に図が挿入されている方が、見やすい本になるでしょう。今回は図の挿入方法をご紹介しようと思います。 表示する図のデータと置き場所 まずは図のもととなる画像ファイルをどこに置くかですが、config.ymlを確認すると以下の様になっています。 # 取り込む画像が格納され…
Re:VIEWに挑戦する連載の9回目です。前回の記事はこちらになります。 hirocom777.hatenadiary.org 複数のファイルをまとめる 前回は、Re:VIEWで変換するPDFファイルの設定を操作してみました。本の形に近づいてきた感じがします。 でも、本を作るのですから1つのファイルだけということは稀でしょう。長くなると収支が付かなくなりますし、途中で章の入れ替え、挿入、削除などしたくなった場合、章ごとにファイルを分けていた方が作業が楽になります。そこで今回は複数ファイルの変換に挑戦したいと思います。 catalog.yml ファイル構成の設定はworkフォルダー内のsampl…
Re:VIEWに挑戦する連載の8回目です。前回の記事はこちらになります。 hirocom777.hatenadiary.org Re:VIEWの設定 前回は、Re:VIEWを使ってRe:VIEWフォーマットのファイルをPDFファイルに変換しました。 でも、ファイルの内容に不可解な点がありました。実をいうと、変換方法の詳細を設定できる方法があります。今回は、この設定を操作してファイルの内容を改善してみようと思います。 config.ymlの編集 設定はworkフォルダー内のsampledocフォルダーの中にあるconfig.ymlファイルを編集することで可能です。config.ymlファイルはテ…
Re:VIEWに挑戦する連載の7回目です。前回の記事はこちらになります。 hirocom777.hatenadiary.org Re:VIEWを使ってみる 前回はDocker Desktopの概要をざっくりですがご紹介しました。そして、Re:VIEWを使える環境を構築してみました。 今回は、いよいよRe:VIEWを使ってみたいと思います。 参考にしたサイト 最初にお断りしますが、今回は以下のサイトを参考にさせていただきました。 github.com 上記ではDocker Toolboxをインストールして使用していますが、現在では非推奨となっています。Docker Desktopでも同様の作業が…
Re:VIEWに挑戦する連載の6回目です。前回の記事はこちらになります。 hirocom777.hatenadiary.org 今回は解説 前回はDocker Desktopでmd2reviewの環境を構築して使ってみました。 今回は前回の解説です。 Dockerコマンド Docker Desktopはコンテナー型のアプリケーション実行環境を構築できるソフトウェアです。色々な環境構築の設定ファイル(イメージ)が公開されていて、前回はmd2reviewのイメージをダウンロードして環境を構築、実行しました。一連の作業はDockerコマンドと呼ばれるコマンドで実施されます。公開されている設定ファイル…
Re:VIEWに挑戦する連載の5回目です。前回の記事はこちらになります。 hirocom777.hatenadiary.org Docker Desktopを使おう 前回はDocker Desktopをインストールしました。 今回は実際にDocker Desktopを使ってツールの環境を構築して使ってみましょう。 md2review ところで一番最初にお話ししましたが、僕はVScodeを使ってMarkDownで本を書いたのです。 techbookfest.org MarkDownは簡単に使えて便利ですよね。このブログもMarkDownで書いてます。だから本の原稿を書くときも、ある程度MarkD…
Re:VIEW で catalog.yml に設定するファイルの分割粒度は「章単位 (Chapter)」になっている.しかし,文章量が増えてくると運用面で「節単位 (Section)」にファイルを分割したくなってくることもある.例えば,以下のように「1章(1節)」と「2章(2節)」と「3章(3節)」でファイルを分割して catalog.yml に設定できる(できるにはできる...). PREDEF: CHAPS: - chapter1.re - section1-1.re - chapter2.re - section2-1.re - section2-2.re - chapter3.re -…
diff-pdfは、オープンソースのPDFファイル比較ツールです。 これをGitHub Actionsワークフローから使用するためのDockerイメージ及びActionを作りましたので紹介します。 github.com diff-pdfには、指定するオプションによって大きく2通りの用途があります。 PDFを出力するシステムの検証のため、出力されたPDFが期待するものと等しいものかを検証する(ビジュアルリグレッションテスト、ゴールデンテスト) Re:VIEWやMarpのようなテキストベースの原稿をPDFなどにレンダリングするツールを使用して執筆している場合に、テキストでなくレンダリング結果の差分…
Texliveを普通にインストールすると、full schemeですべてインストールされて、インストールにものすごく時間がかかるので、Texliveを短時間(basic scheme +アルファ)でインストールしてみた。 環境はUbuntu 20.04、Texlive 2021。 Windowsの場合は、参照にある 【大学生向け】LaTeX完全導入ガイド Windows編(2021/05現在) - Qiita や TeX Live ガイド を参考のこと。 インストール画面まで インストール画面 basic scheme を選択 basic scheme に必要なものを追加 不必要なもののチェッ…
Re:VIEWに挑戦する連載の4回目です。前回の記事はこちらになります。 hirocom777.hatenadiary.org 引き続き準備 前回はLinux(Ubuntu)の環境を構築しました。意外と簡単にできましたよね!!でもまだRe:VIEWを使うにはインストールしなければいけないアイテムがあります。Rubyと日本語TeX環境です。これらを整えた状態でRe:VIEWが動くのです。 でもここで朗報です。これらの問題を一気に片付ける方法がある様です。今回は、その方法についてご紹介したいと思います。 Docker Desktopとは その名はDocker Desktop for Windows…
Re:VIEWに挑戦する連載の3回目です。前回の記事はこちらになります。 hirocom777.hatenadiary.org Linux 前回はRe:VIEWの概要についてお話ししました。VScodeの拡張機能を使ってRe:VIEWフォーマットのプレビューも見てみました。何だか楽しそうですね!! 今回はRe:VIEWを使用する環境の構築、Linuxです。Re:VIEWはOSとしてLinux環境下で動作するのでした。Linuxはご存じだと思いますがコンピューターのOSです。僕のパソコンのOSはWindows 10。でも、最近はWindows 10でもLinuxが比較的簡単に動かせるみたいなんで…