Any GitHub wiki can be cloned by appending wiki.git to the repo url, so the clone url for
the repo https://myorg/myrepo/ is: git@github.com:myorg/myrepo.wiki.git (for ssh) or https://github.com/my/myrepo.wiki.git (for https).
You make edits, and commit and push your changes, like any normal repo. This wiki repo
is distinct from any clone of the project repo (the repo without wiki.get appended).
You need to clone the wiki repo and edit it on your system.
Add images to an images directory (or subdirectory below it) in your wiki repo. For example: images/project-architecture/project-architecture-overview.png.
In your wiki page markup, embed an image link in the following format:
[[/images/path/to/image.ext|ALT TEXT]]
Note the leading / in the path. You don't need it if all your wiki docs and image files are located at the top level of the wiki (like when you use the online wiki editor), but if you are working with a clone of the wiki, then you can organize files in subdirectories; and in that case, absolute or relative path specifiers are critical so that the path to the image resolves correctly when editing a doc that is located in a different subdirectory.
Commit and push your changes.
This is not the same as providing a link to an image that is part of your project repo (not the wiki repo). If you want to link to an image in your project repo, you will need a full URL that looks something like this:
[[https://github.com/username/repository/blob/master/img/octocat.png|alt=octocat]]
See references, below.
You need to clone the wiki repo and edit it on your system.
Add files to the files directory (or subdirectory below it). For example: files/project-presentation.pdf`.
In your wiki page markup, add the file link in the following format:
[link text](files/path/to/file "ALT TEXT")
For example:
[Project Presentation](files/project-presentation.pdf "Project Presentation PDF")
Commit and push your changes.
I currently have a website containing (among other things) the documentation (PHP/HTML) and examples (PDF) from my Github-hosted Perl libraries. POD -> HTML -> edit program and manually add some HTML keywords, etc. -> upload (a mostly automated process), and run examples to produce PDFs -> upload, with manually maintained HTML directory. With each release of a library, I need to refresh most of these files. It's a fair amount of (mostly mindless) labor each time.
Is the Github Wiki a good match for this? You can see what I currently have at https://www.catskilltech.com/FreeSW/product/PDF-Builder/title/PDF%3A%3ABuilder/freeSW_full (for PDF::Builder). "Documentation" and "Examples" are what I'm looking to move to the Wiki. If using the Wiki is a simple matter of POD -> HTML -> automated cleanup -> upload files (for Documentation) and produce PDF examples -> upload files (for Examples), I would be interested. Downloading PDFs would be sufficient, although being able to display them in a browser "live" (without having to explicitly download) would be great. Note that the Examples PHP files (directories) are manually generated at the moment, although I could automate that too. To produce the various files (documentation and examples) on my PC and then bulk upload them to the Wiki, and it's done, would be great. Any guidance on this? If updating this stuff on a Wiki is more labor than I'm doing now, there may not be any point to moving to the Wiki. Otherwise, it would be great to have an easily-updatable Wiki in the same place as the code repository.
If I have to manually edit each Wiki page and paste over the contents with updated material, that would not be any savings in time over what I have now. I really need to be able to upload (preferably using something like FileZilla) a bunch of locally-produced files, and be done with it. Can the Wiki do this? In addition, can it do spell checking for me? It's a pain to do spell-checking with the present system.
Update: Almost every Wiki on Github appears to either be a dummy stub, or is "obsolete -- content now found at x.y.z". Is anyone actually using Github Wiki for documenting their projects? I would think this "How To" document would be a little busier.
As I said above, I can easily generate HTML output of my documentation. I don't mind ginning up a converter to reformat it as Markdown or Wikimedia if that's what it takes. What I'm hoping to do is bulk upload these documentation pages, rather than having to manually update (possibly copy and paste) each one individually. Can this be done? Is there documentation anywhere giving a cookbook approach? Then there's the examples output -- currently mostly PDF files, but some plain text too, and perhaps other formats in the future. Can these be uploaded in bulk? I'd really love to be able to shut down my current website and just use Github's Wiki, if I can keep the mindless labor to a minimum.