Writing Technical Reports

This repository helps you start writing an technical report on GitHub. The source file of the report is written in the pandoc markdown format. You can find the source file in the src folder (document.md).

To start writing your own report, you need to fork or duplicate this repository and edit the source file of the report. Note that if you fork the repository, you cannot make your repository private. To create a private copy of this repository, you need to duplicate it.

Each time that a change is made to the repository, a GitHub Action is executed. Each GitHub Action in this repository generates an artifact, which is a zip file that contains the PDF version of the report. It also updates the PDF files in the src folder.

Writing reports on your computer

You need to clone the repository. If you have docker on your computer, to generate the PDF file (in the output folder), run this command:

./build.sh

References

• Markdown Cheatsheet
• Pandoc
• Pandoc for scholars
• Pandoc markdown lecture template
• minidocks pandoc
• Pandoc Scholar