Link: graphcore-research.github.io
This will allow you to view a local version of the site as you edit.
- (Install Docker)
- Open the folder inside a devcontainer (in VSCode select "Rebuild and Reopen in Container")
- Run
bundle install - Run
bundle exec jekyll serve
This blog is hosted on Github pages. See settings > pages for details.
The blog itself is derived from Minimal Mistakes, which is built on Jekyll. For guidance on how to edit things on the site, your best bet is the Minimal Mistakes Guide. More fundamental info may instead be found in the Jekyll Docs.
All guidance for Papers of the Month authors can be found in the summary template at for_authors/README.md.
The main repo used for developing content is this "internal" one, graphcore-research.github.io-internal. However the "public" repo which is the one that forms the main site is graphcore-research.github.io.
To "publish" the blog, one must merge a given branch into main on this internal repo, then push this main branch to the public repo (this is the only way the public repo should ever be modified, no direct commits).
To deploy from the internal repo to the public one, set up:
git remote add public git@github-personal:graphcore-research/graphcore-research.github.io.git
then run git push public main.
The "Running Locally" section above enables a local preview. One can also view a version of the internal repo (as opposed to the public one) on the public internet (though we don't advertise this anywhere). This can be useful as a sanity check before pushing a change to the public site, as described above.
The link to this preview can be found on the page https://github.com/graphcore-research/graphcore-research.github.io-internal/settings/pages. Note that in the "Build and deployment" section the branch used can be changed from main to the user's chosen branch, which can be useful for e.g. sharing a preview of a branch with others.
Copyright (c) 2024 Graphcore Ltd. Licensed under the MIT License.
The blog is built using Minimal Mistakes (MIT) via the remote theme starter. Minimal Mistakes itself is built on Jekyll (MIT).