HTMLへのビルド/ プレビュー機能

このエクステンションは、テキストエディタの横に、HTMLのプレビューを表示させることができます。 また、プレビューモードが有効な状態でファイルを保存すると、自動的にビルドが開始され、ビューが更新されます。

reST_doc_012.png

手順

  1. rst形式のファイルを選択し、開きます

    reST_doc_007.png

  2. パネルの右上に表示される、三角形マークをクリックします

    reST_doc_019.png

  3. Preview HTML [Built-in build] (現在、Windowsのみの対応)と Preview HTML [User env build] のアイテムが出てくるので、いずれかを選択します

    reST_doc_008.png

    • [Built-in build] : エクステンションに同梱されている実行ファイルを用いてビルドを行います(現在、Windowsのみの対応)

    • [User env build] : ユーザーのマシンにインストールされているSphinxの環境を用いてビルドを行います

      See also

      詳細は ビルド を参照してください

  1. ビルドが実行されると、Terminalに実行状況が表示され、終了すると自動的に閉じます

  2. エディタの右側に、ビルドされたHTMLがプレビューされます

自動更新

  1. rstファイルの内容を変更し、保存します

    • 自動的にビルドが始まり、プレビュー画面が更新されます

  2. ビルドやプレビューを終了する時は、プレビュー画面のパネルを閉じてください

Note

Preview HTML [Built-in build] の実行には、 sphinxhelper.exe という、エクステンションに同梱されているファイルが実行されます。セキュリティソフトによっては制限が加えられる可能性がありますので、このファイルの実行を許可してください。

尚、このexeファイルの元になっているファイル/プログラムは、 GitHub で公開されています。

See also