adding citations support #64
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I am gonna go ahead and deploy this to see if it works as I expect, and we can revert if this isn't a good pattern |
|
cc @matthew-brett who first mentioned this possibility to me :-) |
|
A little behind thanks to deadlines at the moment, but this is awesome !! Definitely something I wanted. I think added complexity is fine if it's documented. Amazing addition ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds the ability to generate citations for the jekyll site. However there is one big caveat, doing this is not possible if you're using GitHub-pages auto-site-generation magic. You need to build the site locally (w/
bundle exec jekyll build) and then push the built HTML to your site. GitHub pages can serve a site from thedocs/folder, and this PR adds the build HTML to that folder in order to show off the citations in the main jupyter-book site.Here's the guide to do it https://predictablynoisy.com/jupyter-book/features/citations
What do folks think about this added complexity? On the one hand, it's simpler to just upload markdown files and have github auto-build the cite for you. On the other, having citation ability is awesome :-)
thoughts @SamLau95 and maybe @emdupre who mentioned citations I think