Markdown

Wat is de Markdown-editor?

De Markdown-editor is een van de drie editoropties die beschikbaar zijn in Document360. Het gebruikt een sierwijze — Markdown genoemd — om tekst te formatteren, die vervolgens wordt omgezet naar HTML wanneer deze op de kennisbanksite wordt weergegeven.

Markdown is een lichtgewicht opmaaktaal waarmee je inhoud kunt opmaken met speciale tekens, zonder dat je direct HTML hoeft te schrijven. Typen **text** maakt bijvoorbeeld tekst vetgedrukt en ## Heading creëert een tweede niveau kop.

De Markdown-editor gebruikt een split-screen layout:

• Linker paneel — Waar je Markdown-syntaxis typt en toepast. Ondersteunde syntaxis zoals koppen kan direct in dit paneel worden gestyled terwijl je typt, wat verwacht gedrag is.

• Rechter paneel — Een live preview die precies laat zien hoe het artikel op de knowledge base-site zal verschijnen zodra het is gepubliceerd.

Je kunt Scroll on inschakelen om beide panelen gelijktijdig te laten scrollen terwijl je schrijft. Klik op Scroll aan om dit uit te schakelen.

Wanneer gebruik je de Markdown-editor

De Markdown-editor werkt het beste wanneer:

• Je artikelen zijn voornamelijk tekstgebaseerd met minimale multimediale elementen.

• Je team is vertrouwd met Markdown-syntaxis of HTML en geeft de voorkeur aan toetsenbord-eerst schrijven.

• Je moet aangepaste HTML-tags of inline code gebruiken die de WYSIWYG-editors niet ondersteunen.

• Je werkt aan code-intensieve documentatie zoals API-referenties of ontwikkelaarsgidsen.

Als je artikelen veel afbeeldingen, video's, tabellen of rijke opmaak bevatten, kan de Advanced WYSIWYG-editor beter passen. → Editors vergelijken in Document360

Basisprincipes van Markdown

Markdown gebruikt eenvoudige tekens om tekst te formatteren. Hier is een snelle referentie van de meest gebruikte syntaxis:

Voor de volledige referentie van de Markdown-syntaxis, zie → Basic Markdown-syntaxis

De Markdown-werkbalk

De Markdown-werkbalk biedt snelle toegang tot opmaakopties zonder handmatig de syntaxis te typen. Opties voor de werkbalk zijn onder andere:

Een Markdown-artikel omzetten naar de Advanced WYSIWYG-editor

Als je een Markdown-artikel naar de Advanced WYSIWYG-editor wilt verplaatsen — om toegang te krijgen tot rijkere contentblokken, Eddy AI en meer opmaakopties — kunt u het op artikelniveau converteren.

Hoe te converteren

1. Open het artikel in de Markdown-editor.

2. Klik op het Meer (•••) icoon rechtsboven in de editor.

3. Selecteer meer artikelopties. Het artikelinstellingenpaneel verschijnt.

4. Ga naar het tabblad Editor .

5. Selecteer de geavanceerde WYSIWYG-editor.

6. Selecteer het vakje 'Weet je zeker dat je verder wilt gaan?' om te bevestigen.

7. Klik op Opslaan.

Het artikel wordt omgezet naar de Advanced WYSIWYG-editor en opent direct in de nieuwe editor.

Wat te verwachten na de bekering

• Alle tekstinhoud, koppen, lijsten en basisopmaak worden overgenomen.

• Sommige Markdown-specifieke syntaxis die niet wordt ondersteund in de Advanced WYSIWYG-editor — zoals Markdown-tabellen — zal na conversie opnieuw moeten worden beoordeeld en opnieuw opgebouwd met de ingebouwde tools van de editor.

• Je kunt de Advanced WYSIWYG-editor als standaard instellen voor alle nieuwe artikelen via Settings > Knowledge Base-portaal > General > Editor. Dit heeft geen invloed op bestaande Markdown-artikelen.

Best practices

• Gebruik de werkbalk als je nieuw bent met Markdown — deze voegt automatisch syntaxis in, zodat je geen commando's hoeft te onthouden.

• Schrijf de syntaxis zorgvuldig — kleine fouten zoals een ontbrekende spatie of een extra teken verhinderen dat de opmaak correct wordt weergegeven.

• Gebruik het live preview-paneel regelmatig om te controleren hoe de inhoud eruit zal zien voordat je publiceert, vooral voor complexe elementen zoals tabellen en codeblokken.

• Vermijd onnodig het mengen van Markdown en HTML — hoewel HTML wordt ondersteund, kan overmatig gebruik ervan inconsistenties in de weergave veroorzaken.

• Overweeg om te schakelen naar de Advanced WYSIWYG-editor als je artikel complexer wordt en inhoudsblokken vereist zoals tabs, accordeons, callouts of interactieve elementen.

FAQ