- ローカル PC に texlive をインストールすることなく VSCode で編集した tex ファイルをコンパイル可能に
- Cloud LaTeX公式 VSCode プラグイン
- ローカル上のファイルと Cloud LaTeX サーバ上のファイルを自動同期
- オフライン時のファイル編集にも対応 (オンライン復帰時に自動同期)
Visual Studio Marketplaceからインストール、あるいはクイックオープン(ctrl/cmd + P)に ext install cloudlatex と入力します.
- Cloud LaTeX のアカウントを持っていない場合は、Cloud LaTeXからアカウントを作成します。
- プロジェクト一覧の右上のユーザ名をクリックし、上から 3 つ目のプラグイン連携を選択する。トークン生成ダイアログが表示されるので、アカウント情報を入力し、生成されるクライアント ID、トークンを記録します。
- プロジェクト一覧からプロジェクトを作成します。（VSCode から利用したいプロジェクトが既に存在する場合はスキップしてください。）
- 作成したプロジェクトのプロジェクト ID を URL より記録します。例:
/projects/123/edit-> プロジェクト ID は123
-
ローカルに空のプロジェクト用フォルダを作成し、VSCode でそのフォルダを開きます。 Activity Barに表示される
CLアイコンをクリックすると Side Bar に二つのボタンが表示されます。
-
Set accountボタン（アカウント設定ボタン）をクリックし、email,client,tokenを設定します。 アカウントの設定は、コマンドパレット(mac:Cmd+Shift+P, win:Ctrl+Shift+P)でcloud LaTeX: Set accountコマンドからも可能です。 -
VSCode の言語設定で日本語が設定されている場合は当拡張機能の表示も日本語化されます。キャプチャ画像は英語のものです。（詳細）
-
次に
Project settingボタン (プロジェクト設定ボタン) をクリックし表示される項目のうち、Cloudlatex.projectIDに準備の項で確認した値を設定し、Clodulatex.Enabledにチェックを付けます。(Project settingボタンが表示されていない場合、プロジェクトフォルダが開かれているか確認してください。)＊
Userタブではなく、Workspaceタブに設定を行う必要があります。
-
プロジェクトのsettings.jsonから設定することも可能です。(右上のアイコンクリックで
settings.jsonを開きます){ "cloudlatex.projectId": 123, "cloudlatex.enabled": true, "cloudlatex.outDir": "./.workspace", } -
LaTeX Workshopと併用することで、pdf のレビューやコマンド補完などが使えるようになります。 この場合、以下のようにして Latex Workshop の自動コンパイルを無効化してください (
latex-workshop.latex.outDirはcloudlatex.outDirと同じ値に設定します)。{ "cloudlatex.projectId": 123, "cloudlatex.enabled": true, "cloudlatex.outDir": "./.workspace", "latex-workshop.latex.autoBuild.run": "never", "latex-workshop.latex.outDir": "./.workspace", "[latex]": { "editor.formatOnSave": false, } } -
設定ファイルを変更すると、VSCode を再起動するよう促すダイアログが表示されるので、ダイアログ中のダイアログ中の
Restart VSCodeボタンを押して再起動します。 再起動後、プロジェクトファイルがダウンロードされます。 ダウンロードが成功すると、ファイル同期に成功した旨のダイアログが表示されます。＊ プロジェクトを同期しなおす際には、同期中にローカルのファイルを削除しないように注意してください。(サーバのファイルも削除されます) また、 同じローカルディレクトリ内で同期するプロジェクトを変更する際には、ローカルファイルが予期せず上書きされないように注意してください。（
projectIdを変更して同期を行うと、元のローカルファイルは上書きされます）＊ プロジェクトファイルがダウンロードされない時は、
reloadボタン(リロードボタン)をクリックするか、一旦 VSCode を閉じ、再度開いてみてください
| Setting key | Description | Default | Type |
|---|---|---|---|
cloudlatex.enabled |
プラグインを有効にするかどうか | false |
boolean |
cloudlatex.projectId |
プロジェクト ID. *設定を間違えるとローカルファイルが別のプロジェクトファイルの内容に上書きされる可能性があるので注意してください | 0 |
number |
cloudlatex.outDir |
コンパイル成果物出力先ディレクトリ | "" |
string |
cloudlatex.autoCompile |
自動コンパイルを有効にするかどうか | true |
boolean |
cloudlatex.supressIcon |
true にすると LaTeX プロジェクト以外のプロジェクトでは Activity Bar に CL アイコンが表示されなくなります |
false |
boolean |
cloudlatex.ignoredFiles |
同期を行わないファイルを指定 | 次項参照 | Array<string> |
cloudlatex.ignoredFiles で指定された glob パターンにマッチしたファイルはファイル同期処理から無視されます。 絶対ファイルパス に対してパターンのマッチング処理が行われます。
指定できるパターンは anymatchと互換性があります。
例
- 'README.md' ファイルを同期させない:
**/README.md - 'bin' 拡張子を持つファイルを同期させない:
**/*.bin - 'test' ディレクトリ以下を同期させない:
**/test/**
デフォルトでは .latexmkrc を除く .から始まるファイル名と LaTeX のコンパイル成果物に関係する拡張子が指定されています。
またパフォーマンス上の理由から cloudlatex.ignoredFiles の設定値によらず、.git, node_modulesは常に同期されません。
cloudlatex.ignoredFiles のデフォルト値
[
"**/*.aux",
"**/*.bbl",
"**/*.bcf",
"**/*.blg",
"**/*.idx",
"**/*.ind",
"**/*.lof",
"**/*.lot",
"**/*.out",
"**/*.toc",
"**/*.acn",
"**/*.acr",
"**/*.alg",
"**/*.glg",
"**/*.glo",
"**/*.gls",
"**/*.ist",
"**/*.fls",
"**/*.log",
"**/*.nav",
"**/*.snm",
"**/*.fdb_latexmk",
"**/*.synctex.gz",
"**/*.synctex\\(busy\\)",
"**/*.synctex.gz\\(busy\\)",
"**/*.run.xml",
"**/.vscode/**",
"**/.!(latexmkrc)"
]
VSCode の言語設定で日本語が設定されている場合は当拡張機能の UI も日本語表示になります。 日本語表示にするにはこちら から Japanese Language Pack をインストールしてください
- オンラインの際にはローカルで行ったでファイルの変更が自動で同期されます。 Cloud LaTeX の web アプリから行ったファイルの変更もローカルに反映されます。
Project setting で cloudlatex.autoCompile にチェックを入れることで、ファイル保存時に自動でコンパイルが行われます。
CL アイコンをクリックすることで表示されるサイドパネルの、 Compile ボタンからコンパイルすることも可能です。
コンパイル完了後、Project setting の cloudlatex.outDir に設定したディレクトリ以下に pdf がダウンロードされます。
-
tex ファイルに構文エラーがあり、コンパイルに失敗した場合、コンパイルに失敗した旨のダイアログが表示されます。
-
Check detailsボタンを押して、コンパイラ出力を確認してください。
-
同一のファイルをローカルとサーバ(Cloudlatex Web エディタ、あるいは Dropbox 連携機能)の両方で編集すると、ファイルのコンフリクトが発生します。コンフリクトが発生すると、ローカルかサーバ、いずれかの変更に合わせる必要があります。
-
コンフリクトを検知すると、以下のダイアログが表示されます。
-
Resolve conflictボタンを押し、PullかPushを選択します。
- Pull: サーバの変更をダウンロードし、サーバに合わせます
- Push: サーバにローカルの変更をアップロードすることで、ローカルに合わせます
現在のコンパイルターゲットはファイルエクスプローラ上の T マークで確認できます
コンパイルターゲットはコンテキストメニューの コンパイルターゲットに設定 より変更できます
リモートサーバとのファイルの同期が失敗しています。
Cloud LaTeX web アプリのプロジェクトにアクセスし、コンパイルターゲットが設定されていない等の問題がないか確認してください。
また、ローカルに不正なファイル（.から始まるファイル、LaTeX で利用されない拡張子を持つファイル等）が存在しないか確認し、存在する場合は削除してください。
問題が解決しない場合、コマンドパレット(mac: Cmd+Shift+P, win: Ctrl+Shift+P)を開き、cloud LaTeX: Reset local コマンドを実行し、強制的にローカルファイルの状態をサーバの状態に合わせることが可能です (注: サーバに同期されていないローカルファイルの変更点は失われます)。
コンパイルターゲットに指定したファイル名を変更または削除すると、コンパイルができなくなります。その場合、Cloud LaTeX web アプリよりコンパイルターゲットを設定しなおしてください。
Project settingの User タブの cloudlatex.autoCompile のチェックを外してください。(Project タブのcloudlatex.autoCompile にのみチェックを入れる必要があります)
トークンの有効期限が切れた可能性があります。サイトにアクセスし、初回と同様の手順でトークンを発行しなおしてください。
「ディレクトリにファイルが存在します。ファイルの上書きを防ぐため、同期を行うディレクトリは空である必要があります。」または「The directory contains files. To prevent overwriting files, the directory to be synchronized must be empty.」というメッセージが表示されてファイルの同期が開始されない
同期を開始するディレクトリに既存のファイルがある場合、意図しない上書きの防止の為に同期が開始されません。 設定の通り、空のディレクトリで VSCode を開いてください。
- VSCode でプロジェクトを開いている時にのみファイルの同期が行われます。そのため、プロジェクトを開いていない際に行ったファイル操作は同期されません。
https://github.com/cloudlatex-team/cloudlatex-vscode-extension/tree/main
Apache License 2.0
development 参照