An automagical report generator for BrainHack Proceedings

• Jane Doe
• John J. Doe

• Research Lab 1, Organization 1
• Research Lab 2, Organization 2

Abstract

Powered by GitHub Actions, Pandoc and Hugo, this simple repository can turn itself into a full-blown article page where you can download the PDF! Zero installation. We hope that this little project encourages all the great hackathon participants to create nifty reports worthy of their projects. If you have any suggestions or improvements, please feel free to open an issue or make a pull request at the brainhack-proceegins/template repository.

• tag1
• tag2
• tag3

Introduction

The bibliography report.bib must respect BibTeX format. You can cite entries in your bibliography using their tags:

• Cite an article: (Doe and Doe 2010)

• Cite a GitHub repository: (Cox 2020)

You can use inline code highlight. This paragraph shows how to add blank lines and how to start a paragraph without indentation.

Remember that this is a LaTex flavored markdown. Therefore, some characters must be used with an escape character within the text:

& % $ # { } \

Section

You can create additional sections as you prefer. Section title levels are determined by the number of hastags as in a traditional markdown file.

Subsection

Subsection content goes here. You can create numerated lists:

1. The labels consists of sequential numbers.

2. The numbers starts at 1 with every call to the enumerate environment.

Equations & formulas

You can add mathematical formulas. Single dollars ($) are required for inline mathematics e.g. \(f(x) = e^{\pi/x}\).

You can also use plain LaTeX for equations. These equations are rendered by MathJax, you can right click on them and explore the rendering options available at your browser!

\[\label{eq:1} \hat f(\omega) = \int_{-\infty}^{\infty} f(x) e^{i\omega x} dx\]

and refer to [eq:1] from text.

Hypothes.is

We enabled hypothes.is for the brainhack proceeding reports. This way, you can annotate, highlight and tag the content collaboratively! You may choose to share your insights with everyone, or keep them private.

Results

Figure files must be placed at the figures folder. You can include figures using the following block:

Note that width=.47 \textwidth above sets scales the figure size in the PDF. To change attributes of the figures on the webpage, please see /figures/figures.css.

To refer a figure in the text, you need to use the respective label defined in its caption: Fig. 1

References