Een README ziet er goed uit op een codehostingplatform, maar klanten, beoordelaars en inkoopafdelingen vragen de projectdocumentatie vaak als pdf om te archiveren. Deze handleiding maakt van het Markdown-bestand een verzorgd document, zonder bouwtools.
De pdf behoudt de structuur van de README, zodat koppen, lijsten, tabellen en codeblokken verschijnen zoals de auteur ze opzette.
Stap voor stap
1
Het README-bestand ophalen
Download README.md uit de repository of sla het op vanuit uw editor. Bestanden tot 1 MB worden geaccepteerd.
2
Omzetten
Open README naar pdf en kies het bestand. Er zijn geen opties; koppen, lijsten, tabellen en codeblokken worden automatisch opgemaakt.
3
Afbeeldingen controleren
Afbeeldingen die naar een internetadres verwijzen worden niet geladen. Als de README op schermafbeeldingen leunt, voeg die daarna toe als eigen pagina’s.
4
Samenvoegen met andere documenten
Open Pdf samenvoegen en voeg de README-pdf toe samen met andere bestanden, zoals een licentie, een wijzigingslogboek of een architectuurdiagram.
5
Pagina’s nummeren
Open Paginanummers aan pdf toevoegen en kies formaat en positie, zodat beoordelaars precieze pagina’s kunnen noemen.
Tools met het label ‘Beveiligde server’ sturen je bestand één keer, via een versleutelde verbinding, naar een geïsoleerde AuraDoc-server. Het wordt verwerkt in een wegwerpproces en verwijderd zodra je het resultaat ontvangt. Beleid voor redelijk gebruik en tegen misbruik