Wat is een .md-bestand en hoe open je het?

Auteur: Gepubliceerd

Kort gezegd: Een .md-bestand is meestal een gewoon tekstbestand in Markdown — een eenvoudige manier om koppen, lijsten, links en andere documentonderdelen aan te geven. Je kunt het in elke teksteditor openen. Een programma dat Markdown ondersteunt, toont ook de opgemaakte versie. Dit soort bestanden wordt vaak gebruikt voor handleidingen, notities, documentatie en webteksten.

Wat betekent de extensie .md?

De extensie .md, het achtervoegsel van de bestandsnaam, duidt meestal op Markdown. Dit is een lichtgewicht opmaaktaal: in plaats van opmaak te kiezen via een werkbalk, typ je eenvoudige symbolen in de tekst. Twee sterretjes aan weerszijden van een woord maken het bijvoorbeeld vet.

Het document blijft ook zonder speciaal programma leesbaar. In een teksteditor zie je de woorden en de opmaaktekens; in de Markdown-voorvertoning zie je de opgemaakte inhoud. Het omzetten van die tekens naar de zichtbare opmaak van het document heet renderen.

Anders dan een .docx-bestand bewaart een Markdown-document geen uitgebreide pagina-indeling, zoals de precieze plaatsing van elementen of afdrukinstellingen. Het draait om de inhoud en de structuur daarvan. De extensie alleen garandeert echter niet wat er in het bestand staat: je kunt een bestand elke naam geven. Een ongebruikelijk .md-document hoeft dus geen geldige Markdown-tekst te bevatten.

Hoe open je een .md-bestand en bekijk je de opmaak?

Om de inhoud te lezen, heb je alleen een editor voor platte tekst nodig, bijvoorbeeld Kladblok, dat bij het besturingssysteem wordt geleverd. Dat is handig als je snel een handleiding wilt bekijken of één zin wilt aanpassen. Je ziet dan ook de symbolen die de opmaak bepalen.

Wil je prettiger werken, kies dan een hulpmiddel met een Markdown-voorvertoning:

Als dubbelklikken op het bestand niet het juiste programma opent, kies dan ‘Openen met’ en selecteer een teksteditor. Je hoeft de extensie niet te veranderen in .txt. Een webbrowser alleen toont een lokaal .md-bestand niet altijd met opmaak: hij kan de ruwe tekst weergeven of aanbieden het bestand te downloaden.

Hoe ziet de Markdown-syntaxis er in de praktijk uit?

Met een korte notitie kun je de basistekens leren gebruiken. Het onderstaande fragment bevat een kop van het tweede niveau, vetgedrukte tekst, een lijst en tekst die als code is gemarkeerd:

## De website voorbereiden

Controleer **vóór publicatie**:

- of de contactgegevens kloppen,
- of het formulier werkt,
- hoe de website eruitziet op een telefoon.

Het startbestand van het project is `index.html`.

In de voorvertoning maken de tekens ## plaats voor de opmaak van een kop, geven de sterretjes woorden een vet uiterlijk en vormen de streepjes een opsomming. De backticks rond index.html markeren de naam als een stukje code. Een lege regel scheidt alinea’s of grotere onderdelen van de inhoud.

Een link schrijf je volgens het patroon [linktekst](adres) en een afbeelding volgens het patroon ![afbeeldingsbeschrijving](pad-naar-bestand). Een afbeelding is meestal niet in het .md-document zelf opgenomen: de notatie verwijst naar de locatie ervan. Als je het document verplaatst, moet je dus ook de afbeeldingsbestanden meenemen en controleren of de paden nog kloppen.

Er bestaan verschillende varianten van Markdown, elk met eigen regels voor het interpreteren van opmaaktekens. Basiskoppen en lijsten worden breed ondersteund, maar tabellen, takenlijsten en voetnoten kunnen per programma anders werken. Is het document bedoeld voor een specifiek systeem, controleer de voorvertoning dan in dat systeem.

Hoe maak je een .md-bestand en deel je het met iemand anders?

Je kunt een nieuw document maken zonder gespecialiseerde software te installeren:

  1. Open een editor voor platte tekst en typ de inhoud met Markdown-opmaaktekens.
  2. Sla het op als tekstbestand, bij voorkeur met de tekencodering UTF-8, zodat Poolse tekens behouden blijven.
  3. Geef het een naam, bijvoorbeeld handleiding.md.
  4. Controleer of het programma niet automatisch de extensie .txt heeft toegevoegd, waardoor de naam handleiding.md.txt is geworden.
  5. Open het document in de Markdown-voorvertoning en controleer de opmaak.

Een Word-bestand hernoemen van handleiding.docx naar handleiding.md converteert het document niet. Je moet de inhoud met een geschikt hulpmiddel exporteren, of als platte tekst plakken en opmaaktekens toevoegen.

Moet de ontvanger de handleiding kunnen bewerken, stuur dan het .md-bestand samen met de gebruikte afbeeldingen. Hoeft diegene alleen het afgewerkte document te lezen, dan kan een PDF die je exporteert vanuit een programma met Markdown-ondersteuning handiger zijn. Welke exportformaten beschikbaar zijn, hangt af van het gekozen hulpmiddel.

Wanneer is Markdown een goede keuze?

Markdown is geschikt wanneer de inhoud belangrijker is dan de grafische vormgeving, bijvoorbeeld bij notities, handleidingen en technische documentatie. Het veelgebruikte bestand README.md beschrijft meestal een project, hoe je het start of hoe je het gebruikt. Omdat het om platte tekst gaat, kun je opeenvolgende versies gemakkelijk vergelijken en gewijzigde zinnen herkennen.

.md-bestanden kunnen ook dienen als bron voor artikelen in websitegeneratoren zoals Hugo. Zo’n systeem zet de inhoud om in een webpagina en geeft die vorm volgens een sjabloon. Een Markdown-bestand op zichzelf is echter geen kant-en-klare website.

Voor een document met een nauwkeurig bepaalde afdruklay-out, uitgebreide tabellen of handmatig geplaatste elementen is een tekstverwerker of opmaakprogramma geschikter. Maak om te beginnen een korte .md-notitie en open die tegelijk als tekst en in de voorvertoning. Je ziet dan meteen het verschil tussen de opmaaktekens en hun effect.

Zie ook: Wat is 2FA?

Lees ook

Lees hoe PHP-FPM PHP-verzoeken verwerkt, verschilt van een webserver en hoe je processen afstemt op verkeer en hostingcapaciteit.
Ontdek hoe BIND als open DNS-serversoftware domeinen beheert, welke rollen het vervult en wanneer zelf beheren zinvol is.
Lees wat het Poolse REGON-register en -nummer betekenen, hoe ze verschillen van NIP en KRS en hoe je bedrijfsgegevens controleert.