Markdown | Adjabkhanian

How to Format a Report: Best Practices and Tips

Tue, 01 Apr 2025 00:00:00 +0000

📑 How to Format a Report: Best Practices and Tips

A report is not just a document; it is an important tool for transmitting information. Proper formatting helps make it clear, structured, and professional. Let’s go over the key principles for preparing a quality report. 📋

📌 Key Principles for Report Formatting:

1. Clear Structure

Divide the report into logical sections: introduction, main body, analysis, and conclusions.

Example structure:

# Project Report
## Introduction
- Objective of the work
- Main tasks

## Main Body
### Data Analysis
- Process and method description
- Technologies used

## Conclusion
- Summary and recommendations

### 2. Visual presentation
- Use **bold text** and *italics* to highlight important points.
- Include **tables** to present data easily.
- Add **graphs and charts** for clarity.

Table example:
md
| Stage | Activities | Time |
|------|---------|-------|
| 1 | Data collection | 3 days |
| 2 | Data analysis | 2 days |
| 3 | Final conclusion | 1 day |

### 3. Minimalism and readability
- Use short paragraphs.
- Leave spaces between blocks.
- Avoid complex wording and overloaded phrases.

### 4. Check for errors
Before sending the report:
✅ Double-check the text for grammatical errors.
✅ Make sure the data is logically structured.
✅ Use spell check tools (Grammarly, LanguageTool).

### 5. Heading Design
Use headings of different levels to clearly navigate the report.
md
# Main Heading (H1)
## Subsection (H2)
### Nested Subsection (H3)

## 🔥 Additional Tips
✅ Add a table of contents at the beginning of long reports.
✅ Use readable fonts (Arial, Roboto, Open Sans).
✅ Include links to additional materials and sources.
✅ If the report contains code, format it as blocks:
md
python
print("Sample code in the report")

## 📌 Summary
Following these tips, you will be able to prepare a report that is clear, informative and professionally designed. A good report is the key to a successful presentation of your work! 📝

📘 What is Markdown and Why Use It?

Sun, 23 Mar 2025 00:00:00 +0000

In the third lab on computer architecture, we got familiar with a lightweight and convenient markup language — Markdown. Its goal is to simplify formatting reports and documentation without the complexity of Word or LaTeX.

🛠 What I Learned

Markdown allows you to:

Create headings using #, ##, ###, and so on
Format text: **bold**, *italic*, ***bold italic***
Make lists:
- Bulleted
- And numbered:
  1. First item
  2. Second item
Add links:
[link example](https://example.com)
Insert images: ![caption](/path/to/image.jpg "tooltip")
Write formulas (like in LaTeX):
$\sin^2(x) + \cos^2(x) = 1$
Add code blocks:
```
git pull
make
```

⚙️ How We Used Markdown in Practice

During the lab, I:

Navigated to the target directory in the terminal:

cd ~/work/study/2023-2024/"Computer Architecture"/labs/lab03/report

Pulled the latest changes from the remote repository:
```
git pull
```
Compiled the report template using make, which generated .pdf and .docx files:
```
make
```
Filled out the report in Markdown format (report.md) and recompiled it:
```
make clean
make
```

Uploaded the result to GitHub:

git add .
git commit -m "feat: add lab3 report in Markdown"
git push

📸 Along the Way…

I added screenshots to the report
Included links to documentation
Wrote formulas and formatted them nicely
Used code blocks to show commands

Markdown makes all of this simple, readable, and clean.

🧠 What I Got From It

I learned how Markdown makes documentation easier.
I found it works great with Git and Pandoc.
With Makefile, I can automate report generation — saves tons of time.
I improved my skills with the terminal and Git — essential tools for any developer.

📚 Tip for Students

Everyone writing reports, articles, or blogs should learn Markdown.

It’s a fast, simple, and universal way to format text that works everywhere:
from GitHub and Notion to Tilda and Hugo.

🧑‍💻 Lab work completed by Hovik, first-year programming student

🎉 Easily create your own simple yet highly customizable blog

Fri, 27 Oct 2023 00:00:00 +0000

Welcome 👋

Table of Contents

Overview

The Hugo Blox website builder for Hugo, along with its starter templates, is designed for professional creators, educators, and teams/organizations - although it can be used to create any kind of site
The template can be modified and customised to suit your needs. It’s a good platform for anyone looking to take control of their data and online identity whilst having the convenience to start off with a no-code solution (write in Markdown and customize with YAML parameters) and having flexibility to later add even deeper personalization with HTML and CSS
You can work with all your favourite tools and apps with hundreds of plugins and integrations to speed up your workflows, interact with your readers, and much more

Get Started

👉 Create a new site
📚 Personalize your site
💬 Chat with the Hugo Blox community or Hugo community
🐦 Twitter: @GetResearchDev @GeorgeCushen #MadeWithHugoBlox
💡 Request a feature or report a bug for Hugo Blox
⬆️ Updating Hugo Blox? View the Update Guide and Release Notes

Crowd-funded open-source software

To help us develop this template and software sustainably under the MIT license, we ask all individuals and businesses that use it to help support its ongoing maintenance and development via sponsorship.

As a token of appreciation for sponsoring, you can unlock these awesome rewards and extra features 🦄✨

Ecosystem

Bibtex To Markdown: Automatically import publications from BibTeX

Inspiration

Learn what other creators are building with this template.

Features

Page builder - Create anything with no-code blocks and elements
Edit any type of content - Blog posts, publications, talks, slides, projects, and more!
Create content in Markdown, Jupyter, or RStudio
Plugin System - Fully customizable color and font themes
Display Code and Math - Code syntax highlighting and LaTeX math supported
Integrations - Google Analytics, Disqus commenting, Maps, Contact Forms, and more!
Beautiful Site - Simple and refreshing one-page design
Industry-Leading SEO - Help get your website found on search engines and social media
Media Galleries - Display your images and videos with captions in a customizable gallery
Mobile Friendly - Look amazing on every screen with a mobile friendly version of your site
Multi-language - 35+ language packs including English, 中文, and Português
Multi-user - Each author gets their own profile page
Privacy Pack - Assists with GDPR
Stand Out - Bring your site to life with animation, parallax backgrounds, and scroll effects
One-Click Deployment - No servers. No databases. Only files.

Themes

Hugo Blox and its templates come with automatic day (light) and night (dark) mode built-in. Visitors can choose their preferred mode by clicking the sun/moon icon in the header.

Choose a stunning theme and font for your site. Themes are fully customizable.

License

Released under the MIT license.

Pandas

Thu, 26 Oct 2023 00:00:00 +0000

Flexible and powerful data analysis / manipulation library for Python, providing labeled data structures.

PyTorch

Thu, 26 Oct 2023 00:00:00 +0000

PyTorch is a Python package that provides tensor computation (like NumPy) with strong GPU acceleration.

🧠 Sharpen your thinking with a second brain

Thu, 26 Oct 2023 00:00:00 +0000

Create a personal knowledge base and share your knowledge with your peers.

Hugo Blox web framework empowers you with one of the most flexible note-taking capabilities out there.

Create a powerful knowledge base that works on top of a local folder of plain text Markdown files.

Use it as your second brain, either publicly sharing your knowledge with your peers via your website, or via a private GitHub repository and password-protected site just for yourself.

Mindmaps

Hugo Blox supports a Markdown extension for mindmaps.

With this open format, can even edit your mindmaps in other popular tools such as Obsidian.

Simply insert a Markdown code block labelled as markmap and optionally set the height of the mindmap as shown in the example below.

Mindmaps can be created by simply writing the items as a Markdown list within the markmap code block, indenting each item to create as many sub-levels as you need:


```markmap {height="200px"}
- Hugo Modules
  - Hugo Blox
  - blox-plugins-netlify
  - blox-plugins-netlify-cms
  - blox-plugins-reveal
```

renders as

- Hugo Modules
  - Hugo Blox
  - blox-plugins-netlify
  - blox-plugins-netlify-cms
  - blox-plugins-reveal

Anh here’s a more advanced mindmap with formatting, code blocks, and math:


```markmap
- Mindmaps
  - Links
    - [Hugo Blox Docs](https://docs.hugoblox.com/)
    - [Discord Community](https://discord.gg/z8wNYzb)
    - [GitHub](https://github.com/HugoBlox/hugo-blox-builder)
  - Features
    - Markdown formatting
    - **inline** ~~text~~ *styles*
    - multiline
      text
    - `inline code`
    -
      ```js
      console.log('hello');
      console.log('code block');
      ```
    - Math: $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$
```

renders as

- Mindmaps
  - Links
    - [Hugo Blox Docs](https://docs.hugoblox.com/)
    - [Discord Community](https://discord.gg/z8wNYzb)
    - [GitHub](https://github.com/HugoBlox/hugo-blox-builder)
  - Features
    - Markdown formatting
    - **inline** ~~text~~ *styles*
    - multiline
      text
    - `inline code`
    -
      ```js
      console.log('hello');
      console.log('code block');
      ```
    - Math: $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$

Highlighting

Highlight important text with mark:

<mark>Highlighted text</mark>

Callouts

Use callouts (aka asides, hints, or alerts) to draw attention to notes, tips, and warnings.

By wrapping a paragraph in {{% callout note %}} ... {{% /callout %}}, it will render as an aside.

{{% callout note %}}
A Markdown aside is useful for displaying notices, hints, or definitions to your readers.
{{% /callout %}}

renders as

A Markdown aside is useful for displaying notices, hints, or definitions to your readers.

Or use the warning callout type so your readers don’t miss critical details:

A Markdown aside is useful for displaying notices, hints, or definitions to your readers.

📈 Communicate your results effectively with the best data visualizations

Wed, 25 Oct 2023 00:00:00 +0000

Hugo Blox is designed to give technical content creators a seamless experience. You can focus on the content and Hugo Blox handles the rest.

Use popular tools such as Plotly, Mermaid, and data frames.

Charts

Hugo Blox supports the popular Plotly format for interactive data visualizations. With Plotly, you can design almost any kind of visualization you can imagine!

Save your Plotly JSON in your page folder, for example line-chart.json, and then add the {{< chart data="line-chart" >}} shortcode where you would like the chart to appear.

Demo:

You might also find the Plotly JSON Editor useful.

Diagrams

Hugo Blox supports the Mermaid Markdown extension for diagrams.

An example flowchart:

```mermaid
graph TD
A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]
```

renders as

graph TD A[Hard] -->|Text| B(Round) B --> C{Decision} C -->|One| D[Result 1] C -->|Two| E[Result 2]

An example sequence diagram:

```mermaid
sequenceDiagram
Alice->>John: Hello John, how are you?
loop Healthcheck
    John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!
```

renders as

sequenceDiagram Alice->>John: Hello John, how are you? loop Healthcheck John->>John: Fight against hypochondria end Note right of John: Rational thoughts! John-->>Alice: Great! John->>Bob: How about you? Bob-->>John: Jolly good!

An example class diagram:

```mermaid
classDiagram
Class01 <|-- AveryLongClass : Cool
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 --> C2 : Where am i?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
Class08 <--> C2: Cool label
```

renders as

classDiagram Class01 <|-- AveryLongClass : Cool Class03 *-- Class04 Class05 o-- Class06 Class07 .. Class08 Class09 --> C2 : Where am i? Class09 --* C3 Class09 --|> Class07 Class07 : equals() Class07 : Object[] elementData Class01 : size() Class01 : int chimp Class01 : int gorilla Class08 <--> C2: Cool label

An example state diagram:

```mermaid
stateDiagram
[*] --> Still
Still --> [*]
Still --> Moving
Moving --> Still
Moving --> Crash
Crash --> [*]
```

renders as

stateDiagram [*] --> Still Still --> [*] Still --> Moving Moving --> Still Moving --> Crash Crash --> [*]

Data Frames

Save your spreadsheet as a CSV file in your page’s folder and then render it by adding the Table shortcode to your page:

{{< table path="results.csv" header="true" caption="Table 1: My results" >}}

renders as

Table 1: My results
customer_id	score
1	0
2	0.5
3	1

👩🏼‍🏫 Teach academic courses

Tue, 24 Oct 2023 00:00:00 +0000

Hugo Blox Builder is designed to give technical content creators a seamless experience. You can focus on the content and the Hugo Blox Builder which this template is built upon handles the rest.

Embed videos, podcasts, code, LaTeX math, and even test students!

On this page, you’ll find some examples of the types of technical content that can be rendered with Hugo Blox.

Video

Teach your course by sharing videos with your students. Choose from one of the following approaches:

Youtube:

{{< youtube D2vj0WcvH5c >}}

Bilibili:

{{< bilibili BV1WV4y1r7DF >}}

Video file

Videos may be added to a page by either placing them in your assets/media/ media library or in your page’s folder, and then embedding them with the video shortcode:

{{< video src="my_video.mp4" controls="yes" >}}

Podcast

You can add a podcast or music to a page by placing the MP3 file in the page’s folder or the media library folder and then embedding the audio on your page with the audio shortcode:

{{< audio src="ambient-piano.mp3" >}}

Try it out:

Test students

Provide a simple yet fun self-assessment by revealing the solutions to challenges with the spoiler shortcode:

{{< spoiler text="👉 Click to view the solution" >}}
You found me!
{{< /spoiler >}}

renders as

👉 Click to view the solution

You found me 🎉

Math

Hugo Blox Builder supports a Markdown extension for $\LaTeX$ math. Enable math by setting the math: true option in your page’s front matter, or enable math for your entire site by toggling math in your config/_default/params.yaml file:

features:
  math:
    enable: true

To render inline or block math, wrap your LaTeX math with $...$ or $$...$$, respectively.

Example math block:

$$
\gamma_{n} = \frac{ \left | \left (\mathbf x_{n} - \mathbf x_{n-1} \right )^T \left [\nabla F (\mathbf x_{n}) - \nabla F (\mathbf x_{n-1}) \right ] \right |}{\left \|\nabla F(\mathbf{x}_{n}) - \nabla F(\mathbf{x}_{n-1}) \right \|^2}
$$

renders as

$$\gamma_{n} = \frac{ \left | \left (\mathbf x_{n} - \mathbf x_{n-1} \right )^T \left [\nabla F (\mathbf x_{n}) - \nabla F (\mathbf x_{n-1}) \right ] \right |}{\left \|\nabla F(\mathbf{x}_{n}) - \nabla F(\mathbf{x}_{n-1}) \right \|^2}$$

Example inline math $\nabla F(\mathbf{x}_{n})$ renders as $\nabla F(\mathbf{x}_{n})$.

Example multi-line math using the math linebreak (\\):

$$f(k;p_{0}^{*}) = \begin{cases}p_{0}^{*} & \text{if }k=1, \\
1-p_{0}^{*} & \text{if }k=0.\end{cases}$$

renders as

$$ f(k;p_{0}^{*}) = \begin{cases}p_{0}^{*} & \text{if }k=1, \\ 1-p_{0}^{*} & \text{if }k=0.\end{cases} $$

Code

Hugo Blox Builder utilises Hugo’s Markdown extension for highlighting code syntax. The code theme can be selected in the config/_default/params.yaml file.

```python
import pandas as pd
data = pd.read_csv("data.csv")
data.head()
```

renders as

import pandas as pd
data = pd.read_csv("data.csv")
data.head()

Inline Images

{{< icon name="python" >}} Python

renders as

Python

Markdown | Adjabkhanian

How to Format a Report: Best Practices and Tips

📑 How to Format a Report: Best Practices and Tips

📌 Key Principles for Report Formatting:

1. Clear Structure

📘 What is Markdown and Why Use It?

🛠 What I Learned

⚙️ How We Used Markdown in Practice

📸 Along the Way…

🧠 What I Got From It

📚 Tip for Students

🎉 Easily create your own simple yet highly customizable blog

Overview

Get Started

Crowd-funded open-source software

❤️ Click here to become a sponsor and help support Hugo Blox’s future ❤️

Ecosystem

Inspiration

Features

Themes

License

Pandas

PyTorch

🧠 Sharpen your thinking with a second brain

Mindmaps

Highlighting

Callouts

Did you find this page helpful? Consider sharing it 🙌

📈 Communicate your results effectively with the best data visualizations

Charts

Diagrams

Data Frames

Did you find this page helpful? Consider sharing it 🙌

👩🏼‍🏫 Teach academic courses

Video

Podcast

Test students

Math

Code

Inline Images

Did you find this page helpful? Consider sharing it 🙌