emcek / f-4e-manual

Manual of the F-4E Phantom by Heatblur Simulations

F-4E Manual

Manual of the F-4E Phantom by Heatblur Simulations. This is a mdBook project, content is written in the language Markdown (.md).

The manual is automatically exported as HTML version, hosted at https://f4.manuals.heatblur.se/. PDF versions are available from the release section.

Setup

Markdown is supported widely by most IDEs and text editors. We recommend VSC and any JetBrains IDE, such as Fleet, IntelliJ or CLion.

You can also simply press . (dot) while on GitHub and it will open an instance of Visual Studio Code right in your browser, allowing you to contribute directly and conveniently.

Please read CONTRIBUTING.md before your first contribution.

Building locally

To build the website locally, you have to install mdBook, see here.

Then run the command mdbook build from this folder; the website can be found in the folder book/html. Use mdbook serve to make the contents available in your browser at localhost:3000, it automatically updates whenever the contents change.

To build the PDF locally, use cargo install mdbook-pdf first. Then, when running mdbook build, the PDF will be created in book/pdf.

GH Pages

The project is automatically configured via a CI/CD to build and publish any change to master to a GH-Pages branch called html. GitHub will automatically publish the website on https://heatblur-simulations.github.io/f-4e-manual/, linked to https://f4.manuals.heatblur.se/ via CNAME.

PDF Deploy

PDF versions are automatically build and published at https://github.com/Heatblur-Simulations/f-4e-manual/releases via CI/CD whenever a tag is pushed to git.