Hur GitHub rangordnar README-filer
TLDR; Alfabetisk.
Jag gillar GitHub, dels för smidig hosting av källkod men också för kollaborering och spridning av idéer. För tydlig presentation och dokumentation av projekt används README-filer. GitHub renderar dessa filer till HTML från en mängd olika format.
Av dessa föredrar jag Markdown (.md),
men tillägg i WordPress-katalogen kräver en README med filändelsen txt. GitHub parsar
txt-filer som plain/text trots att de innehåller Markdown-syntax.
För att vara både GitHub och WordPress-katalogen till lags för presentation av mina
tillägg behöver jag två README-filer i samma katalog i repot, README.md och
readme.txt.
Som tur är prioriterar GitHub .md före .txt, dock saknas dokumentation om hur de
övriga formaten rangordnas. Därför gjorde jag lite
tester som gav följande:
- asciidoc
- creole
- md|mkdn?|mdwn|mdown|markdown
- mediawiki|wiki
- org
- pod
- rdoc
- re?st(.txt)?
- textile
- txt
- utan filändelse