Q why am I trying to do non wiki stuff in the GitHub wiki - AndyGlew/Test-GitHub-stuff GitHub Wiki

NOTE: 2020-08-18: Renaming file to eliminate special characters in filename. note that most eliminate both special characters that are urlencode, and characters that are disallowed by cygwin/Windows, which is where I'm currently editing it.


Q: why am I trying to do non wiki stuff in the GitHub wiki?

A: ...

NOTE: for the https://github.com/AndyGlew/Ri5-stuff wiki, CMOs draft proposal, I managed to do most of this, building the document PDF and HTML from the wiki.

  • TBD: link to a proper place explaining how and why - living in a Test wiki not appropriate

Doc in wiki with tools

I would like to write documents in the GitHub wiki, and have tools that can extract a subset of the wiki pages and create a nice printed PDF of them.

As an alternative to having an AsciiDoc document in a repo blob, with a separate wiki.

  • if I did this I would want to be crosslinking between the wiki and repo blob all the time - and as far as I can tell, the syntax to do that is unpleasant.

If I write a doc in the wiki, I would want to version the wiki and tools together.

  • it's a pain to have to check out wiki and associated repo separately.
  • e.g. make the tools a submodule of the wiki
    • making the wiki a submodule of the tools loses, because the tools may be shared between many wikis.

want subdirectories / subwikis (FAIL)

Lossage

Things that don't work as well in a GitHub wiki as they do an actual GitHub repo file:

GitHub repo files can refer to issues as simply #1, issue number. This does not work in the wiki :-(

See https://github.com/AndyGlew/Test-GitHub-stuff/issues/1, I wish I could reference as #1 in the wiki the same way I can reference it in the repo