0. はじめに
本記事は,レガシーな組版処理システムであるLaTeXを扱うための統合開発環境の一つである「Overleaf」をVSCodeで操作可能にするための手順について説明します.
LaTeXに関する詳細な説明は省略します.予めご了承ください.
1. Overleafとは
まずは,Overleafに関する簡単な説明を行います.
Overleafは,オンラインでLaTeX文書を作成・編集・共有するためのクラウドベースのプラットフォームです.
クラウドベースのプラットフォームであるため,ローカルにLaTeX環境を構築する必要がなく,誰でも簡単にLaTeXを使うことのできる便利なツールです.
ローカルに環境構築をすることによるメリットは多くあります(ネットワーク環境やアクセス過多による負荷に依存しないなど).
あくまで,LaTeXの環境構築をスキップして,クイックスタートしたい方やLaTeX初心者の方推奨です.
2. VSCodeでOverleafを動作させるメリット
Overleafはブラウザでのみ動作可能なプラットフォームであり,本記事で紹介する手法を使うとVSCodeで操作することが可能になります.
メリットとしては以下が考えられます(筆者の見解).
- 見慣れたインターフェースで編集可能
- 誤ってタブ・ウィンドウを閉じてしまう心配が少ない
- VSCodeの様々な拡張機能が使用可能
筆者が中でも気に入っている点は「GitHub Copilotが動作する」ことです!
GitHub Copilot
AIを用いてリアルタイムでの補完・提案・生成を行うことでコーディング効率を向上させる,VSCodeなどの統合開発環境で利用できるプログラミングツール.
VSCodeにGitHub Copilotを導入させておくと,コーディングと同様にLaTeXを編集している時も助けてくれます.
例えば,何か文章を書いている時には「後に続く文章候補を自動で生成」してくれたり,LaTeXでコンパイルエラーを起こした時には「自動で適切な構文に修正」してくれたりと色々便利なアシストをしてくれます.
※まだVSCodeにGitHub Copilotを導入していない方は,以下のサイト等が参考になると思いますので,導入しておくことをおすすめします.
3. VSCodeでOverleafを操作する手順
VSCodeでOverleafを操作できるようになるまでの手順を大きく以下のステップで説明していきます.
- Overleafのアカウントを作成
- VSCodeでOverleafにログイン
3.1. OverLeafのアカウントを作成
まず,以下のページからOverleafアカウントの作成を行います.
サインアップは,メールアドレスとパスワードを入力し,コード認証を行うだけで完了できます.
※この際,有料プランへの加入を勧められますが,無料で使用したい人は「No, I don't need these」を選択して丁重にお断りしましょう.
以上で,Overleafアカウントの作成は完了となります.
補足:プロジェクトの作成
アカウントの作成が完了すると,スタート画面が表示されます.
「Create a new project」をクリックし「空のプロジェクト」をクリックします.
プロジェクト名の入力を求められますので,適当な名称(Testなど)で作成してください.
プロジェクトは複数作成可能で,いつでも名称変更・削除が可能
プロジェクトを作成すると,画面左にソースファイル,画面右にテキストファイルが表示されると思います.(以下の画像は,空のプロジェクト(プロジェクト名:Test)を作成した場合の例)
3.2. VSCodeでOverleafログイン
先ほど,サインアップしたOverleafのアカウントにVSCodeでログインします.
まず,VSCode拡張機能の検索欄に「Overleaf Workshop」と入力し,インストールまで完了させます.
インストールが完了すると,サイドバーにOverleaf Workshopという名前のアイコンが追加されますので,これをクリックします.
すると「www.overleaf.com」というホストが表示されるので,そこにカーソルを合わせて,ホスト名の右側にある「Login to Server」をクリックします.
ログイン手段の選択が求められますが,Cookiesを用いたログイン方法「Login with Cookies」を選択してください.すると,Cookies情報の入力が求められますので,自身のOverleafのCookies情報を入力します.
OverleafのCookies情報の取得
OverleafのCookies情報取得方法を説明します.
まず,以下のページから,Overleafに自身のアカウントでログインします.
ログインすると,以下の画像のようなページが表示されます.
このページのCookie情報を取得し,Overleaf Workshopのログイン時に入力することでVSCodeでOverleafにログインすることができます.
補足:ページのCookie情報を取得する方法
まず,管理者画面を開きます(F12キーを押す,または右クリックで「検証」).
管理者画面内の「Network」タブをクリックし,検索欄に「/project」と入力します(以下,入力後の画面例).
この画面のまま,ページを更新すると,projectという名称のRequestURLを含む通信が出てきます.
その中のprojectドキュメントをクリックし,Response HeadersのSet-Cookieに記載されている文字列(以下の画面の黒塗り部分)をコピーしてください.
以上で,OverleafのCookies情報の取得が完了しました.
4. まとめ
本記事では,オンラインで使用できるLaTeXエディタ「Overleaf」を,VSCodeで操作する方法を説明しました.
特に,LaTeX未経験の方や,環境構築が面倒くさいと食わず嫌いしている方などにLaTeXを触るきっかけにでもなれば幸いです.
本記事で説明した内容はOverleaf workshopの公式Gitリポジトリで詳細に記述されています(全て英語ですが).気になる部分や説明で分かりにくかった部分は公式ドキュメントでご確認ことを強く推奨します.
マイページ紹介