-
Notifications
You must be signed in to change notification settings - Fork 7
Github Wiki integration
Ábel Vértesy edited this page Feb 27, 2016
·
3 revisions
- Create a wiki of your project repo on Github. It is separate from your code repo.
-
Clone the wiki to your local computer. Create the Reports folder in the wiki's repo.
-
Create your report and revise it once more to check if it is understandable for others, axes labels, legends are correct, etc...
-
Convert all pdf files into .png (GitHub cannot display .pdf at the moment).
- You need to create .png versions of .pdf images - (a current limitation of GitHub). See a how-to for OS X.
-
Copy the report (.md) file with the .png images to the backup subdirectory created by the MarkdownReports package.
-
Remove the timestamp from the directory's name & copy the folder to the Reports folder in the wiki's local repository.
-
Commit your changes & check the results online!