Ga naar inhoud

Plug-in Markdown-voorbeeld

Een live voorbeeld naast het actieve Markdown-document, weergegeven in een dokbaar paneel dat bijwerkt terwijl u typt. De weergever heeft geen afhankelijkheden (hij gebruikt de ingebouwde rijketekstweergave van Qt, geen webengine), dus deze plug-in is altijd beschikbaar en voegt geen zware afhankelijkheden toe.

Waar u het vindt

Beeld ▸ Markdown-voorbeeld opent (of sluit) het voorbeelddok voor het huidige tabblad. Het dok verkiest de rechterkant en kan als elk ander paneel gesleept, zwevend gemaakt of in tabbladen gezet worden.

Hoe het zich gedraagt

  • Live weergave. Het voorbeeld wordt opnieuw weergegeven terwijl u typt, met een vertraging zodat het typen vlot blijft (die vertraging wordt voor heel grote bestanden automatisch soepeler).
  • De cursor volgen. Met Cursor volgen aan (werkbalk) schuift het voorbeeld naar het blok dat u bewerkt zodra de cursor naar een andere regel gaat. Omdat alleen een cursorbeweging het laat schuiven, springt het voorbeeld bij een Zoekopdracht naar de treffer en laat het u daarna met rust: u kunt van de treffer wegschuiven en het voorbeeld blijft staan waar u het zet, tot u de cursor weer verplaatst. Zet de optie uit om het voorbeeld volledig onafhankelijk te laten schuiven. De instelling wordt onthouden.
  • Themabewust. De kleuren van het voorbeeld komen uit het actieve editorthema (tekst, codeblokken, blokcitaten, koppelingen), zodat het voorbeeld bij een licht of donker thema past en live bijwerkt wanneer u van thema wisselt. U kunt deze kleuren fijn afstemmen in de Thema-editor, onder de categorieën Markdown.
  • Exporteren / in de browser openen. De werkbalk kan de weergegeven HTML naar een bestand exporteren of hem in uw standaardbrowser openen. In beide gevallen krijgt u een schone, zelfstandige pagina: eenvoudige, semantische opmaak zonder de steigers die het paneel alleen voor zichzelf nodig heeft, en een vaste lichte stijl, zodat het gedeelde bestand normaal leest, ongeacht uw editorthema.
  • Paneelgrootte. Het voorbeeld houdt een aandeel van het venster in plaats van een vaste breedte, dus het groeit en krimpt mee met het venster — zie Opgeslagen indeling.

Zichtbaarheid van het voorbeeld

De zichtbaarheid van het voorbeeld wordt per bestand onthouden, zowel binnen een sessie als over herstarts heen:

  • Markdown-bestanden (.md, .markdown, .mdown, .mkd, .mkdn, .mdwn, .markdn, .mdtxt) openen het voorbeeld automatisch de eerste keer dat u ze bekijkt. Deze standaard van «automatisch openen» is een blijvende schakelaar onder Beeld ▸ Markdown-voorbeeld automatisch openen.
  • Andere bestanden doen dat niet — maar u kunt het voorbeeld op elk bestand openen met Beeld ▸ Markdown-voorbeeld, en het geeft dat bestand als Markdown weer.
  • Binnen een sessie wordt wat u voor een tabblad kiest hersteld wanneer u ernaar terugkeert.
  • Over herstarts heen wordt uw uitdrukkelijke keuze voor een bestand onthouden: sluit het voorbeeld op een bestand en het blijft gesloten de volgende keer dat u dat bestand opent; open het voorbeeld op een bestand dat het niet automatisch zou openen en het gaat weer open. Bestanden die u nooit uitdrukkelijk hebt aangeraakt volgen eenvoudigweg elke keer de standaard van het automatisch openen — zodat het later aanzetten van automatisch openen nog steeds voorbeelden opent die u nooit met opzet hebt gesloten.

Wat er weergegeven wordt

  • Opmaak in de regel — *cursief*, **vet**, ***vet cursief***, ~~doorgestreept~~, code in de regel en harde regeleinden.
  • Koppen — zowel de #-vorm als de onderstreepte (setext) vorm.
  • Lijsten — geordend en ongeordend, genest, compact of los (een losse lijst krijgt alinea-afstand), beginnend bij het nummer dat u hebt geschreven, en takenlijsten: - [ ] en - [x] worden ☐ en ☑.
  • Tabellen — tabellen met verticale strepen en uitlijning per kolom (links, gecentreerd, rechts). Een te korte rij wordt aangevuld, een cel te veel valt weg, en een brede tabel breekt af in plaats van afgekapt te worden.
  • Code — blokken met omheining en ingesprongen blokken, getekend in een omrand, gevuld kader in een letter met vaste breedte, zodat een blok zich van de tekst onderscheidt en ASCII-diagrammen en uitgelijnde kolommen hun vorm houden.
  • Koppelingen en afbeeldingen — in de regel, als verwijzing ([tekst][ref] met de definitie waar dan ook in het bestand) en kale http://-, https://- of www.-adressen, die vanzelf koppelingen worden. Paden naar afbeeldingen worden opgelost ten opzichte van het bestand.
  • Blokcitaten en horizontale lijnen.
  • YAML-front matter — het --- … ----metadatablok dat sommige gereedschappen bovenaan een bestand verwachten, wordt als een yaml-codeblok getoond en niet voor een kop aangezien.

Rauwe HTML wordt met opzet als tekst getoond: opmaak wordt ontsnapt in plaats van uitgevoerd, zodat een document bekijken dat u niet zelf hebt geschreven niets kan uitvoeren. HTML-blokken en voetnoten worden niet weergegeven.

Welke koppelingen opengaan

Op een koppeling in het voorbeeld klikken opent hem alleen als de bestemming http, https of mailto is; een #fragment schuift het voorbeeld naar die kop. Elke andere bestemming — een file:-pad, een gewoon of relatief pad, een javascript:-adres, het eigen schema van een of andere toepassing — wordt genegeerd, en de statusbalk zegt welke koppeling niet is geopend en waarom. De reden is het document zelf: een Markdown-bestand dat u hebt gekloond of gedownload is de tekst van iemand anders, en één klik erin mag geen programma op uw machine kunnen starten.

Met de muis over een koppeling gaan laat zien waar hij naartoe leidt voordat u klikt, met een tweede regel wanneer het er een is die het voorbeeld niet zal openen.

Zie ook

  • HTML-voorbeeld — voorbeeld met volledige getrouwheid (CSS/JavaScript) voor HTML en PHP, met QtWebEngine.
  • Thema-editor — stel de Markdown-kleuren van het voorbeeld bij.