I'm fairly new to GitHub and I've been trying to get the GitHub Wiki associated with a project to get the content from the main repository with no success.
Online there are guides on how to do this on Microsoft Azure here, but for some reason, I cannot find anything similar for GitHub. I am not sure where to ask this question so I came to the trusted StackOverflow community.
Basically I have a repository where we are uploading a series of markdown documents (see giovannellilab/protocols) and I would like the content of the wiki for the same project to be updated with pages coming from the repository. Each markdown file in the repository becomes its own wiki page. Ideally, the wiki will get automatically updated every time we push something new to the repo or we merge a new pull request.
So far I have not found an easy to implement a solution.
I've also tried to use a GitHub Action found in the marketplace, SwiftDocOrg with no success. I'm new to GitHub-actions and even follwing the guide I could not make this work.
Here the content of my .yml page:
- name: Publish to GitHub Wiki
uses: SwiftDocOrg/github-wiki-publish-action#1.0.0
with:
# A path to the directory of files to publish
path: giovannellilab/protocols
The action is failing each time (obviously something is wrong/missing, but I cannot figure out what).
Any suggestions on how to make it work in GitHub?
Any other place where I can host documentation pulling directly from a GitHub repository?
Any other better way to implement this?
Thank you very much,
Don
Related
I have a couple questions related to GitHub template repositories. My team regularly creates repositories from a GitHub template repository. We also have a GitHub team and like to add all of our repositories to our team.
My questions are:
Anytime a new repository is created from our template repository, how can it be automatically added to our GitHub team's list of repositories?
Anytime a new repository is created from our template repository, how can myself (and someone else) automatically be made admins of this new repository (even if we didn't create the repository)?
I've searched all over documentation and Stack Overflow for possible solutions but came up empty handed. I've looked into using CODEOWNER files which might be useful, but don't look like they're designed for this use case. I've also looked into creating new repositories from the GitHub CLI using the template repository and maybe a shell script to add it to our GitHub team, but was hoping for a simpler solution.
Thanks for any thoughts or suggestions!
I'm trying to figure out if there's any way to deploy this project https://github.com/nataliecardot/zeus-hosting-setup, preferably to GitHub Pages. No dist folder is created when I run foundation build, which apparently is an old issue. Is it possible for my to deploy this in any way? Or if not, any other way to get it online?
You need to generate the static pages that will be published online, and do so in the appropriate branch.
Since master includes what is necessary to generate the pages, said pages need to be stored in a gh_pages branch.
See "Types of GitHub Pages sites" and its next section "Publishing sources for GitHub Pages sites".
The point remains: that repository as it is, with only its master branch, would not make any page visible on its own.
I have a Jekyll blog that I have hosted on GitHub Pages. What I am trying to do is update the existing repo with my new files. I wasn't sure what to do because I didn't want to delete the repo, and I didn't want duplicate files (old and new), just my new files from my new directory.
My question is (giving another breakdown first)-
I have deleted the old directory locally that included my hosted GitHub Pages Jekyll blog files.
I re-made a new Jekyll blog locally under the same name as my previous directory (using *jekyll new username.github.io *)
I still have my old blog files in my jekyll blog repo on GitHub.
I would like to delete the old files (but not the repo), and update that repo with my new blog files. How would I go about doing that?
Assuming it's a normal git repo, you should be able to link it with the upstream repo in the usual way (further details to come in an edit).
Jekyll/Github docs: https://help.github.com/articles/using-jekyll-with-pages
You should be able to run git push from your new repo, and it should just work. If not, hopefully a git pull beforehand should solve it. If not, post a comment and I'll see if I can help.
I've created my own gitbook. looks good locally.
but how shall I integrate it into my github pages? Similar issues here difficulty-in-getting-gitbook-site-to-show-up-in-github-page
I tried that approach as well, but I have problem setting the grunt up, and I also I would like to do that myself before using an integrated tool.
I tried to copy the generated _book folder to my github page folder, but that didn't workout as there are some encoding issues
Similar question here
I had this question because I don't understand github pages, the underlying steps involve
build the _book folder, this is the static content that will be served
create gh-pages branch copy the _book folder content into gh-pages
github will then serve the content
the command gitbook publish will finish all 3 steps. but I am not familiar with grunt as well , as npm install . is a pre-step.
Good day.
Could you help me with a little problem I am experiencing.
I have a jekyll blog on the github. The problem is after I updated my old post, committed and pushed it, the blog post doesn't show any changes, but I see that the commit has been pushed successfully.
If I run jekyll --server locally, it shows updated blog post and it doesn't report any errors.
I have no jekyll plugins installed.
What am I doing wrong or misunderstanding? Thanks a lot.
Added by Nawaz:
I'm facing exactly same problem. My I pushed added one markdown post and few css, and modified layouts and includes, then I pushed them to github. It is done successfully. My github is showing all the changes in the repository, but the github blog (i.e the generated html posts out of markdown) are still same. No change to them at all. It is showing some posts which doesn't even exist in the repository. But when I do jekyll --server locally, then every update is being shown on my (local) blog hosted at http://localhost:4000.
Please help me!
If your Jekyll site is not rendering properly after you push it to GitHub, it's useful to run Jekyll locally so you can see any parsing errors. In order to do this, you'll want to use the same version that we use.
GitHub's Pages servers currently use Jekyll 0.11.0 with Liquid 2.2.2, and run it using this command:
$ jekyll --pygments --safe
More info
I'm now trying to solve the problems with my pygments highlighting (works locally, doesn't show on github at all, even though I'm receiving mails about succesful build). Findings so far:
Make sure that youre repository' default branch is 'master' (go to your repository Admin page).
Put your Jekyll source files in some other branch, and put the _site content to your master branch. There will be no _config.yml, no YAML front matter so github will render your stuff as is, and you would be building it locally on that other branch. This actually worked for me. It requires some manual labour when moving _site from that other branch to your master, but I'm fine with that - at least I do not have to rely on github build process which seems to be a bit buggy, plus, I can have whatever plugins I wish.
When ever you generate your jekyll site locally for testing, always run jekyll --no-auto --server. This would display if there were any errors encountered during the generation of your site. Also, before generating your site delete _site directory and then run the command as described above.
Let me know if you see any errors as such. We can debug further