Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding citations support #64

Merged
merged 1 commit into from
Dec 19, 2018
Merged

adding citations support #64

merged 1 commit into from
Dec 19, 2018

Conversation

choldgraf
Copy link
Collaborator

@choldgraf choldgraf commented Dec 19, 2018

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 the docs/ 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

@choldgraf
Copy link
Collaborator Author

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

@choldgraf choldgraf merged commit 3efb0e7 into master Dec 19, 2018
@choldgraf
Copy link
Collaborator Author

cc @matthew-brett who first mentioned this possibility to me :-)

@emdupre
Copy link
Collaborator

emdupre commented Dec 19, 2018

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants