4

Should I be using the Wiki functionality of Github/Gitlab, or should I create Markdown files within the repo?(or both?)

I've opted for the Markdown files because I don't know if the wiki pages are portable, or how to access them offline. Also, I have images that are referred to by their relative paths. I'm not sure where the wiki pages are stored and how to use relative paths instead of absolute paths.

George
  • 2,820
  • 4
  • 29
  • 56
  • The wiki pages, at least in GitLab, can be accessed as a git repository, so yes, you can access them offline. – 1615903 Aug 10 '17 at 04:12

1 Answers1

1

The wiki pages are markdown pages.

GitLab proposes Wiki-specific Markdown with, for instance, [Link to File](file.md) as a way to point to a file, relative to the current page.

GitHub, for instance, explains how to add images from your repo into your wiki page, again in markdown.

Both explain how to access/clone/update your wiki:

  • GitHub help page: 

    git clone https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.wiki.git

  • GitLab issue

    git clone https://source.example.com/group/project.wiki.git
VonC
  • 1,262,500
  • 529
  • 4,410
  • 5,250
  • There is also a "group wiki" with GitLab 13.5 (Oct. 2020) but without Git URL yet: https://stackoverflow.com/a/64506695/6309 – VonC Oct 23 '20 at 20:18