https://github.com/adamspannbauer/hosting-ipynbs-with-github-pages

https://github.com/adamspannbauer/hosting-ipynbs-with-github-pages

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/adamspannbauer/hosting-ipynbs-with-github-pages
• Owner: AdamSpannbauer
• License: mit
• Created: 2023-09-26T12:00:24.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-09-26T12:12:05.000Z (almost 3 years ago)
• Last Synced: 2025-03-02T18:20:06.699Z (over 1 year ago)
• Language: HTML
• Homepage: https://adamspannbauer.github.io/hosting-ipynbs-with-GitHub-Pages/
• Size: 1.56 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Hosting ipynbs with GitHub Pages

A tutorial/example on how to use GitHub pages to host python notebook files as web pages.  Please see [here](https://adamspannbauer.github.io/hosting-ipynbs-with-GitHub-Pages/) for the full document (which was made as an .ipynb file!).

### Quick overview instructions

* [Make a Github repo](https://docs.github.com/en/get-started/quickstart/create-a-repo#create-a-repository)

* Make an R Markdown file you're proud of and want to share with the world!

* Export the notebook to html

* Name the html document `index.html`

* Get the `index.html` file into your GitHub repo

  * Long term I recommend to find a Git+GitHub tutorial and learn how to interact with git.  It's such a useful skill for so many different things!

    * [here's a great one if you're just getting started with git](https://www.youtube.com/watch?v=BCQHnlnPusY&list=PLRqwX-V7Uu6ZF9C0YMKuns9sLDzK6zoiV)

  * Short-term you can use the Add file button followed by clicking Upload files

* Turn on GitHub pages for the repo by clicking:

  * Settings

  * Pages (under the Code and automation section in the sidebar)

  * Find the dropdown menu in the **Branch** section of the page and select "main" (there's a chance you want to select "master")

    * If you're new to GitHub there's probably only one option to choose, choose that one option that's not "None"

  * Click the Save button

* Wait!

* Find your website online at:`https://.github.io/