https://github.com/afbjorklund/lima-man
User manual for lima VM
https://github.com/afbjorklund/lima-man
lima-vm manual
Last synced: 3 months ago
JSON representation
User manual for lima VM
- Host: GitHub
- URL: https://github.com/afbjorklund/lima-man
- Owner: afbjorklund
- License: cc-by-sa-4.0
- Created: 2022-05-13T19:00:14.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T08:32:52.000Z (about 1 year ago)
- Last Synced: 2025-07-19T14:28:23.239Z (3 months ago)
- Topics: lima-vm, manual
- Language: TeX
- Homepage:
- Size: 1.25 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# User Manual
This manual is built with
This is a template that uses [Pandoc](https://pandoc.org/) to auto-generate PDF and HTML manuals based on markdown content.
Please install the most recent Pandoc package to get best results on your local computer.
## PDF generation
PDF files are generated using LaTeX, so a working LaTeX engine needs to be installed on your system already (e.g. texlive incl. extra fonts). The manual uses the [Eisvogel](https://github.com/Wandmalfarbe/pandoc-latex-template) template.
```
cd manual
make pdf
```
## HTML generation
The HTML template is based on the great [mdBook](https://github.com/rust-lang-nursery/mdBook) theme, which was simplified and adjusted a bit to suit the needs of a manual.
```
cd manual
make html
```
## Docker image
Included is a Dockerfile with all the dependencies for pandoc and latex installed.