Skip to content
This repository has been archived by the owner on Jan 12, 2024. It is now read-only.

Use Jupytext to create index for mybinder deployment #409

Merged
merged 6 commits into from Aug 20, 2020

Conversation

cgranade
Copy link
Contributor

This PR adds a new Markdown file, binder-index.md, that can be used as a landing page for mybinder.org deployment. By adding jupytext as a Dockerfile dependency, binder-index.md appears to Jupyter Notebook as a Q#-language notebook, enabling some really neat experiences. For example, if you follow the "CHSH Game" link below, that takes you to a Jupyter Notebook rendering of that sample's README.md:

image

That README.md is then itself an executable PowerShell-language notebook, such that instructions in the ordinary README can be executed in-place:

image

So far, this PR has been tested in VS Code devcontainers, but once merged in we can test with binder before redirecting the ★binder branch to point to the new samples landing experience.

@guenp
Copy link
Contributor

guenp commented Aug 19, 2020

@cgranade This is indeed really neat! would it be an idea to add a note on how to use said features to CONTRIBUTING.md?

@cgranade
Copy link
Contributor Author

@cgranade This is indeed really neat! would it be an idea to add a note on how to use said features to CONTRIBUTING.md?

That's a good idea, @guenp, totally agreed. I think that should be deferred until after we test with mybinder deployment, however, so that we can make sure any advice that we add there is as accurate as possible.

Copy link
Contributor

@rmshaffer rmshaffer left a comment

Choose a reason for hiding this comment

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

Looks really cool; I look forward to trying this out!

Copy link
Member

@msoeken msoeken left a comment

Choose a reason for hiding this comment

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

This is a great overview page. Thanks!

samples/algorithms/database-search/README.md Outdated Show resolved Hide resolved
Co-authored-by: Mathias Soeken <mathias.soeken@outlook.com>
@cgranade cgranade merged commit b3fc88d into master Aug 20, 2020
@cgranade cgranade deleted the cgranade/binder-index branch August 20, 2020 16:41
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants