Developer Overheid NL website

Dit is de repository van de website developer.overheid.nl, de kennisbank, communities en blog.
De basis van de website is Docusaurus, de artikelen bestaan uit Markdown- (of MDX-) bestanden, deze slaan we in deze repository op, waardoor we met versionering en reviews kunnen werken.

Help mee

Wil je bijdragen aan onze kennisbank, blog en of website. Op de pagina Bijdragen staan de verschillende manieren waarop je mee kan helpen.

Contact

Neem contact op met ons via een bericht op ons Slack kanaal of stuur een e-mail naar developer.overheid@geonovum.nl. Dan kijken we samen hoe we je bijdrage kunnen vormgeven.

Lokaal draaien van de website

We gebruiken pnpm om afhankelijkheden te installeren en de website met Docusaurus te draaien. Zorg dat je dat eerst installeert, dat kan bijvoorbeeld met npm.
Daarna kan je de website lokaal draaien.

1. Draai pnpm install om te zorgen dat alle afhankelijkheden die Docusaurus nodig heeft beschikbaar zijn
2. Draai pnpm run start om te builden en Docusaurus te starten.

Daarna kan je de lokale versie van de site bekijken op http://localhost:3000/.
Maak je aanpassingen aan de design tokens, draai pnpm run build om de CSS te builden.

WCAG pnpm script

Het pnpm run lint:wcag script vereist extra dependencies die niet in de package.json staan om het aantal dependencies beperkt te houden.

Installatie dependencies

Voer eerst de stappen uit zoals beschreven in .github/workflows/check-wcag.yml. Draai daarna:

pnpm run lint:wcag