[Alg] Readme.md, waarmee openen?

[hneel]

Ik kom de laatste tijd steeds vaker software sources tegen waar dan een readme.md bestand bij zit. Veel spul van github o.a.
Maar ik heb nooit begrepen wat dat .md voor extensie is. Het is meestal wel gewoon met een text editor te lezen, maar ik zie ook vaak markup-achtige dingen er tussen staan, en ik heb het idee dat het als platte tekst niet optimaal leest. Kortom: met wat voor soort reader wordt ik geacht dit te lezen?

[True]

.md staat voor markdown, je kunt het gemakkelijkste met een markdown reader werken (gebaseerd op mijn aanname dat je geen IDE-achtige software gebruikt).

[FireDrunk]

MD staat voor MarkDown, en kan je in diverse tools die speciaal voor ontwikkelaars zijn openen.

Voorbeelden: Visual Studio Code, Atom of IntelliJ IDEA bijvoorbeeld.

Als je echt alleen de basis wil lezen, is Wordpad / Notepad(++) ook prima.

[ Voor 18% gewijzigd door FireDrunk op 14-02-2023 13:35 ]

[Oon]

Beetje overkill, maar je zou het met iets als Typora kunnen openen, of als je het op GitHub vindt gewoon niet het rauwe bestand openen dan laat hij de geformatteerde versie zien.

Het nadeel is dat de Markdown standaard redelijk beperkt is, en dus veel websites hun eigen 'dialect' gebruiken, wat dan weer niet lekker leest in zo'n editor.

[CodeCaster]

GitHub zelf heeft een renderer voor deze MarkDown-files. Zie bijvoorbeeld https://github.com/home-a...ontend/blob/dev/README.md.

[NESFreak]

Dat is markdown: Wikipedia: Markdown

Het is juist de bedoeling dat het ook als text zeer leesbaar is, maar bijvoorbeeld github zelf kan er wat moois van maken.

github: About READMEs

Een readme.md word door github dan ook standaard als hoofdpagina getoond en vaak zijn linkjes in git repository markdown files ook zo bedoeld dat ze werken als je ze via github bekijkt.

[ Voor 29% gewijzigd door NESFreak op 14-02-2023 13:38 ]

[hneel]

Ok, een soort "html light" dus, zeg maar.
Maar het blijft nog even zoeken naar de beste/handigste tool om ze vanuit verkenner mee te openen om te lezen.
Met internet browsers als Chrome of Edge lukt het alvast niet. Mijn favoriete editor is UltraEdit, maar die laat alleen de platte tekst zien.

[RobIII]

Kijk eens naar VS Code. Snel, lightweight, gratis, kan overweg met MarkDown in code en WYSIWYG mode. Duizend keer beter dan een veredelde notepad als ultraedit en kan overweg met talloze formaten dankzij de vele beschikbare extensions.

[ Voor 22% gewijzigd door RobIII op 14-02-2023 14:06 ]

[NESFreak]

hneel schreef op dinsdag 14 februari 2023 @ 14:00:
Ok, een soort "html light" dus, zeg maar.
Maar het blijft nog even zoeken naar de beste/handigste tool om ze vanuit verkenner mee te openen om te lezen.
Met internet browsers als Chrome of Edge lukt het alvast niet. Mijn favoriete editor is UltraEdit, maar die laat alleen de platte tekst zien.

Met Visual studio code kun je op <CTRL><SHIFT><V> drukken en dan krijg je een real time preview van je markdown.

Verder kun je met pandoc een markdown file omzetten naar word of pdf.

En voor chrome zijn er plugins als
Markdown Preview Plus https://chrome.google.com...fcbhebfnokafefeacimjdckgl
en Markdown Viewer https://chrome.google.com...hmcjmikdlpkmbgfkaikojcbjk

[hneel]

NESFreak schreef op dinsdag 14 februari 2023 @ 14:06:
[...]
Met Visual studio code kun je op <CTRL><SHIFT><V> drukken en dan krijg je een real time preview van je markdown.

Ah, dat is de truuk. Standaard zag ik nog steeds de kale tekst.

[Knutselsmurf]

PowerToys bevat ook een MarkDown preview handler:
https://learn.microsoft.c...s/powertoys/file-explorer

[downtime]

hneel schreef op dinsdag 14 februari 2023 @ 14:00:

Ok, een soort "html light" dus, zeg maar.
Maar het blijft nog even zoeken naar de beste/handigste tool om ze vanuit verkenner mee te openen om te lezen.
Met internet browsers als Chrome of Edge lukt het alvast niet. Mijn favoriete editor is UltraEdit, maar die laat alleen de platte tekst zien.

UltraEdit heeft een ingebouwde viewer voor markdown. Je kunt zelfs in split-screen modus de opgemaakte versie zien terwijl je het textdocument edit.

[Stukfruit]

En mocht je jezelf afvragen waarom bovengenoemde tools een Markdown-pagina op een vreemde manier weergeven: dat komt doordat er verschillende "flavors" zijn.

https://commonmark.org
https://github.github.com/gfm/

Dit is meestal te zien aan de ondersteuning voor bijvoorbeeld tabellen en dingen zoals checkboxes die soms wel en soms niet werken.

Maar zoals min of meer al eerder werd aangegeven: je hoeft het eigenlijk niet om te zetten. Markdown is er om gelezen te kunnen worden zonder speciale tools. Leesbaarheid met vooral de mogelijkheid om het wat mooier te maken is zo'n beetje het punt van Markdown