Skip to content

The Art of Making Coffee

A demonstration article showcasing the capabilities of VitePress.


Introduction

Coffee is a useful subject for demonstrating documentation features:

  • it has a process;
  • it has parameters;
  • it has code;
  • it has tables;
  • it has warnings;
  • it has multiple approaches.

And most importantly, you can drink it while writing documentation.

Tip

Do not add complexity unless you understand why you need it.

Information

This page intentionally contains different VitePress features.

Warning

Water temperature has a significant effect on the result.

Danger

Never leave a coffee machine unattended while it is operating.


1. Quick Recipe

  1. Heat the water.
  2. Grind the coffee.
  3. Add the water.
  4. Wait.
  5. Drink the coffee.

Checklist

  • [x] Buy coffee
  • [x] Buy water
  • [x] Find a mug
  • [ ] Wash the mug
  • [ ] Make coffee

2. Parameters

ParameterValueNotes
Coffee18 gMedium grind
Water300 mlFiltered
Temperature94 °C±2 °C
Time3:00Depends on the method

More coffee generally means a stronger drink.


3. Code

VitePress provides excellent syntax highlighting.

JavaScript

js
function makeCoffee(coffee, water) {
  return {
    coffee,
    water,
    ready: true
  }
}

console.log(makeCoffee(18, 300))