What is the difference between a GitHub gist and GitHub wiki page?
I have steps that I want to share with the GitHub community so they can modify their profile settings. But unsure which one to use
Gist is an independent service with some really nice metadata including when it was last active and versioning, just like GitHub proper. Wikis don't check into git as a version control system.
Supporting docs:
About wikis
About gists
Related
I was wondering if anyone has found a good solution for publishing their jsdoc/better-docs documentation on a website that isn't Github Pages (for privacy concerns)? I've built an api to retrieve the html files from the documented project but it loses the better-docs templating when it's no longer within the same project. Any recommendations would be appreciated. Thanks!
Github is pretty secure and you can also make everything private if needed.
I would recommend Github, if not you can always opt for any alternatives like:
GitLab
SourceForge
BitBucket
Launchpad
you can read here more: https://itsfoss.com/github-alternatives/
What is the recommended approach on GitHub to organizing documentation when working on a new version that represents a major rewrite?
In my project pg-promise I rely on jsDoc to generate all the documentation, and then publish it into gh-pages, as one usually does.
And while working on a new version that's a major rewrite and a documentation change, what is the best approach to making the new/unreleased documentation available? -
1. Should I simply create a separate repository just for the sake of publishing updated documentation there?
2. Should I use an external hosting/solution altogether?
3. Is there any GitHub feature that will let me publish more than one documentation version?
Thanks in advance!
This is feasible using Github Actions along with a static site generator (SSG) of your choice such as VuePress, Gatsby, Jekyll etc.
In its simplest form, create a GH action to generate the static site folder of the branch/release, then push the folder to corresponding folder in the branch pointed to by GH pages, say gh-pages. One of the branches/releases should be pushed to root. GitHub Pages Deploy Action can be helpful. Add a dropdown list of versions to your static website pointing to the matching folder.
Example:
GitHub action
dropdown list implemented by Vue component
rendered site powered by GH pages
I've a lot of documentation in github wiki. I would like organize it and create a book out of it. When ever I update the wiki, the book should be updated. Is this possible ?
Welcome to Gitbook. This service might help you.
https://docs.gitbook.com/integrations/github/import-of-github-wikis
This service as far I read doesnt support github wiki directly.
However because github stores wiki as a seperate repository with reponame.wiki.git, you should be able to import this github repo into gitbook.
I have a private repo that's part of an organization on GitHub. I don't see the normal link to the repo's wiki that I've seen on many other repos. How do I get to it?
I did a little more digging and figured this out, decided I’d document it for the next person. The GitHub wiki is a setting that’s off by default. From the repo page select Settings on the right side, then in the Features section check Wikis.
I've used GitHub pages to generate a beautiful website for my project (this one). Now I want to keep the documentation of my project up to date, and having everything in a single README.md file is probably not scalable to the many features we are adding.
So, I thought that the best place to keep the documentation is the GitHub wiki, but I'd like to integrate the wiki to the gh-pages generated site, keeping the beautiful layout.
How would I take the GitHub wiki and generate an HTML web site with a customizable layout?
Here is an example URL for a wiki:
https://github.com/golang/go/wiki
On the same page you will find a clone link:
https://github.com/golang/go.wiki.git
Then run the Markdown files through Hugo or even create a new repository
to the host site based on the Wiki.
You could include your wiki as subtree.
BTW, GitHub Pages now no longer need the gh-pages branch. Create a repository named your-user-name.github.io; it will automatic generate to a website. See GitHub Pages for more detail.