Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jotavare/latex-preview-container
A web IDE akin to Overleaf, featuring automatic LaTeX compilation and PDF preview.
https://github.com/jotavare/latex-preview-container
codespaces devcontainer docker git gitlab gitpod latex latex-workshop pearl texlive yml
Last synced: 2 months ago
JSON representation
A web IDE akin to Overleaf, featuring automatic LaTeX compilation and PDF preview.
- Host: GitHub
- URL: https://github.com/jotavare/latex-preview-container
- Owner: jotavare
- License: mit
- Created: 2024-06-21T00:41:07.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-22T23:54:50.000Z (5 months ago)
- Last Synced: 2024-09-30T23:02:21.501Z (3 months ago)
- Topics: codespaces, devcontainer, docker, git, gitlab, gitpod, latex, latex-workshop, pearl, texlive, yml
- Language: Shell
- Homepage:
- Size: 361 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## ABOUT
This repository provides a Codespace environment for instantly and automatically building and previewing LaTeX files.
The initial goal was to develop a Visual Studio Code extension for building LaTeX files and previewing PDFs "on-the-fly" within the web IDE. However, this is impractical due to the following limitations:
1. LaTeX processing relies on various packages and dependencies typically run in a local environment.
2. Web IDEs have limited access to the file system and system-level utilities.
The optimal approach is to create an extension using a codespace with all necessary dependencies. However, using a Docker image with Codespaces remains the simplest and most reliable solution for me at the current moment.
## HOW TO USE
#### CODESPACES:
1. Fork or use this repository and click on `Code`.
2. Click `Create codespace on main`.
3. Wait 2-3 minutes for the codespace to finish building.
4. Open `latex/sample.tex`.
5. Click the green triangle or press `Ctrl + Alt + B` to build the LaTeX project.
6. View `sample.pdf` in the `latex/PDF` directory.
7. Customize the layout, e.g., 50% `sample.tex` and 50% `sample.pdf`.
8. Changes to the `.tex` file will automatically rebuild and update the PDF preview.
> [!NOTE]
> The initial PDF preview may take about 30 seconds to set up correctly. It will also open a new window for port forwarding. Once successful, this window can be closed.
#### GITPOD:
Can also use Gitpod to create an environment based on this repository, click [here](https://gitpod.io/#https://github.com/jotavare/latex-preview-container/) or use the link below:
```
https://gitpod.io/#https://github.com/jotavare/latex-preview-container/
```
> [!NOTE]
> Unlike Codespaces, Gitpod offers instant PDF previews from the start. No waiting for the first time.
## DOCKER IMAGE
The Docker image pulls the latest full version of TeX Live without documentation and source files, installs `git` and `perl`, and cleans unnecessary files, totalling 2.33GB. Depending on the project needs, other tags like `minimal`, `small`, or `medium` may also be used, to reduce codespaces build time.
- [TeX Live Docker Images Tags](https://hub.docker.com/r/texlive/texlive/tags)
## FOLDER AND FILE STRUCTURE
```bash
latex-preview-container/
│
├── .devcontainer/
│ ├── devcontainer.json # Configuration file for Codespaces devcontainer
│
├── docker/
│ ├── Dockerfile # Dockerfile for setting up the development environment
│ ├── docker-compose.yml # Docker Compose file for managing Docker containers
│
├── latex/
│ ├── sample.tex # Sample LaTeX file for testing purposes
│
├── LICENSE # Licensing information for the project
└── README.md # Project documentation
```
## REFERENCES
Below are links I used to create this repository and other information that may be useful in the future.
| Link | Source |
| :-- | :----- |
| [TeX Live](https://tug.org/texlive) | `Website` |
| [TeX Live Docker Image](https://hub.docker.com/r/texlive/texlive) | `Website` |
| [Installing TeX Live](https://tug.org/texlive/acquire-netinstall.html) | `Website` |
| [The Comprehensive TeX Archive Network](https://www.ctan.org/) | `Website` |
| [James-Yu/LaTeX-Workshop](https://github.com/James-Yu/LaTeX-Workshop) | `GitHub` |
| [PDFTeX](https://www.tug.org/applications/pdftex/) | `Website` |
| [WebLaTex](https://github.com/sanjib-sen/WebLaTex) | `GitHub` |
| [TinyTeX](https://yihui.org/tinytex/) | `Unix` |
| [MiKTeX](https://miktex.org/) | `Windows` |
| [MacTeX](https://tug.org/mactex/) | `Macintosh` |
## TYPST
Typst is a new markup-based typesetting system that is designed to be as powerful as LaTeX while being much easier to learn and use.
| Link | Source |
| :-- | :----- |
| [Typst](https://github.com/typst/typst) | `GitHub` |
| [Typst Setup](https://github.com/typst-community/setup-typst) | `GitHub` |
| [Typst Actions](https://github.com/lvignoli/typst-action) | `GitHub` |
| [Typst Live](https://github.com/ItsEthra/typst-live) | `GitHub` |
## FUTURE PLANS
- [ ] Create a smaller and optimized Docker image with minimal tools for LaTeX, to build and preview PDF files.
- [ ] Include new extensions in the `devcontainer.json` to enhance the workflow, such as grammar check, code formatting, Copilot, dark mode, etc.
- [ ] Explore the [LaTeX Workshop](https://github.com/James-Yu/LaTeX-Workshop/wiki) extension wiki to provide more features and utilities to the devcontainer.
## CONTRIBUTING
If you find any issues or have suggestions for improvements, feel free to fork the repository and open an issue or submit a pull request.
## LICENSE
This project is available under the MIT License. For further details, please refer to the [LICENSE](https://github.com/jotavare/latex-preview-container/blob/main/LICENSE) file.