LaTeX Document Template for VS Code with the LaTeX Workshop Extension, featuring automated document compilation and release via GitHub Actions and git tags.
Writing the document using VS Code
- Ensure you have the LaTeX Workshop Extension installed in VS Code and a TeX distribution installed on your system.
- Open a LaTeX file (e.g.
main.tex) in VS Code. - Make your changes and save the file.
- The local build process should automatically start, generating a
main.pdffile in theoutfolder.
To create a new release:
- Add a git tag at the desired commit using the format
v*(e.g.v1.2.3). - Push the tag to your repository.
- GitHub Actions will compile the document into a PDF and create a new release for the tagged version.
- Once completed, you can download the PDF document from the release page.
This template follows the hierarchy shown below:
├── figures
│ └── painting.png
├── sections
│ └── example-section.tex
├── main.tex
├── references.bib
You can customize this hierarchy to suit your preferences, but it's essential to keep the main.tex file in the root directory.
If you choose to rename it, ensure to update the release.yml file accordingly to reflect the new main file.
For further customization of the project structure, refer to the xu-cheng/latex-action@v2 repository, which is used for compiling the document.
For the automatic document compilation and release GitHub Actions are used. The workflow is defined in the release.yml file and can be configured there.
The repository automates the document compilation and release using GitHub Actions. The workflow is defined in the release.yml file and can be customized to suit specific requirements.
The workflow depends on the following:
- actions/checkout@v2: Action to checkout the repository
- xu-cheng/latex-action@v2: Action for compiling LaTeX documents
- softprops/action-gh-release@v1: Action for creating GitHub releases