Content toevoegen
Hoe voeg ik nieuwe content toe?
Kijk of er een bestaande pagina is (bijvoorbeeld over Lando) waar je je content moet toevoegen.
We proberen alles te categoriseren. Voeg dus geen fix voor een random Homebrew bug toe onder het topic homebrew/installeren.
Categorie toevoegen
Doe dit alleen als het echt NERGENS onder valt.
Maak een nieuwe map aan in de src/docs
folder.
Geef deze een omschrijvende naam, e.g. lando.
Daarna:
Subcategorie toevoegen
Maak een nieuwe subfolder die duidelijk verteld wat hierin te vinden is (e.g. bugfixes) met daarin een omschrijvende-naam.mdx
Bovenin ieder .mdx bestand moet het volgende staan:
title zet de titel van je pagina. Deze wordt ook gebruikt voor de navigatie. Deze staat gelijk aan een H1 element. lastUpdated zorgt ervoor dat de datum van de laatste update automatisch wordt toegevoegd.
Dit wordt uitgelezen via codepot.
Sidebar
Deze genereerd automatisch. Je hoeft hier dus niks aan te doen.
Dit is waarom omschrijvende namen belangrijk zijn. De sidebar met bovenstaand voorbeeld zou er zo uit zien:
- lando
- bugfixes
- omschrijvende-naam.mdx
- bugfixes
Content
Houd je zoveel mogelijk aan de styleguide / MDX syntax.