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.

Sign up for GitHub

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

Jump to bottom

Jupyter readme #15

Open

Bert-Proesmans opened this issue Oct 14, 2024 · 1 comment

Contributor

Bert-Proesmans commented Oct 14, 2024

Check if it's possible to use a jupyter notebook as readme.

REF; https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes

Collaborator

Weltschmerz-dev commented Oct 18, 2024

After researching and testing it doesn't seem possible.

add support for Jupyter README.ipynb isaacs/github#1425
Tried to symlink in a test repo, didn't work

I opt for a README.md that covers the basics:

What the project does
Why the project is useful
How users can get started with the project
Where users can get help with your project
Who maintains and contributes to the project

And link to a seperate .ipynb file containing the documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment