Markdown gebruiken om gestructureerde documentatie te schrijven
Inleiding¶
Het bijhouden van hoe je project in elkaar zit en wat je heb gedaan, noemen we documentatie.
Je bent waarschijnlijk gewend om in Word te werken, maar het is in ons vakgebied gebruikelijker om te documenteren in Markdown.
Markdown is een simpele taal, waarmee je in tekstbestanden en op Gitlab snel kan schrijven en opmaak kan aanbrengen waar nodig. Markdown is hiermee echt krachtig en veelzijdig.
Zowel de Knowledgebase, de projectdocumentatie als ook deze learning story is opgesteld met behulp van Markdown.
Wat moet ik kunnen?¶
Begrijp wat Markdown is en hoe je het kan gebruiken.
De basisvaardigheden van Markdown:
- Markdown bestaand aanmaken
- Titel
- Kopjes
- Subkopjes
- Dik gedrukte tekst
- Onderstreepte tekst
- Opsomming
- Checklist
- Hyperlinks als tekst
- Afbeeldingen met onderschrift
- Afbeeldingen afmetingen
- Qoutes
- Referenties/Verwijzingen
- Tabellen
- Code in Markdown
Hoe leer ik dat?¶
Kijk voor meer informatie over Markdown in de knowledgebase.
Hoe toon ik dit aan?¶
- Een of meerdere pagina’s die gebruik maken van de meest voorkomende onderdelen en commit deze naar gitlab.
- Publiceer minstens één markdown pagina ion de
/docsfolder van jeLearning Journey - Licht mondeling toe wat de meest interessante markdown onderdelen zijn in je documentatie.