How do you get access to the wiki files?

[An-Unnamed-Developer]

Select Topic Area

Question

Body

I would like to display my GitHub repository's wiki on a webpage, but I can't embed/iframe or get the data directly and just display the html via JS. Anyway I could do this?

[An-Unnamed-Developer]

What I want to do is access the raw wiki files

[seyLu]

Hi @An-Unnamed-Developer,

Since the wiki is it's own git repository, there's currently no way to programmatically access its contents via the API.

What you can do though, since the wiki is a separate repo and is in markdown, is host the wiki on Github Pages or any static website hosting platform (eg. Cloudfare, Vercel, etc).

If you chose Github Pages, the github wiki uses a different markup than what Jekyll supports, so you also need to convert it to github flavored markdown. I haven't tested these tools personally, but you're free to try them out yourself:

• pandoc
• mediawiki-to-gfm
• github-wikito-converter

Or use hugo and a perl script to convert github wiki markup to be compliant with hugo syntax.

You can read more on:

• Github blog: Git-backed wikis
• StackOverflow: Is there any API endpoint to read Github wiki

[An-Unnamed-Developer]

Actually you can by entering this url, https://raw.githubusercontent.com/wiki/user/repo/page.md and this returns the data in the page 😄

[Nileena]

Hi, I was able to get content via raw api as mentioned. Is there any way to list the pages in wiki?

[rcriii42]

Hi Nileena,

On the wiki on github, at the lower right of the screen, is a link to clone the wiki locally. The wiki pages are in a repository at https://github.com/user/project.wiki.git. The wiki pages are in a repository at https://github.com/user/project.wiki.git. It will clone into a directory called project.wiki with the pages as markdown files.