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

add instructions to run notebooks locally #107

Merged
merged 2 commits into from
May 12, 2020
Merged

add instructions to run notebooks locally #107

merged 2 commits into from
May 12, 2020

Conversation

rfourquet
Copy link
Contributor

Partly addresses #98 (this does nothing about adding Project.toml files etc.)
I'm not sure if how I put it is not too much hand holding...

Preview at https://rfourquet.github.io/oscar-website/example/. These new instructions might look too prominent compared to the notebook link themselves.

example.html Outdated
@@ -4,6 +4,28 @@
---

Clicking on the example will open a static version of the example, powered by <a href="https://nbviewer.jupyter.org/">nbviewer</a>.
To interact with a "live" version, it is possible from there to download the notebook and run it locally:
<ul>
<li>right-click on the download icon of the notebook (in the upper right corner), which will allow
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What kind of click is it on Mac?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right click if one has a mouse or knows how to do this on the touchpad; otherwise ctrl-click ; might also say something like:

open the context menu on the download (via right-click on Linux and Windows, or ctrl-click on macOS)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok thanks

@@ -4,6 +4,28 @@
---

Clicking on the example will open a static version of the example, powered by <a href="https://nbviewer.jupyter.org/">nbviewer</a>.
To interact with a "live" version, it is possible from there to download the notebook and run it locally:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW how about converting this file from HTML to markdown (one can embed HTML into a md file, so the <div class="gallery_example"> stuff at the end could probably stay unchanged).

At least for me, editing Markdown feels more convenient. But that's taste, so don't feel obliged to do this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes absolutely! I feel quite uncomfortable writing HTML when Markdown would seem to suffice. I will investigate how to do that (but not in this PR).

@rfourquet rfourquet merged commit 00669cf into gh-pages May 12, 2020
@rfourquet rfourquet deleted the rf/nb-guide branch May 12, 2020 13:14
@rfourquet
Copy link
Contributor Author

I will try to find a way to make these instructions less prominent (e.g. hidden by default with just a pointer would be nice).

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