Fancy GitHub

Contents:

  • Welcome!
  • Organizing your repositories
  • Ignoring files with .gitignore
  • README, your repo’s front page
  • Special considerations for Jupyter notebooks
  • Customizing your GitHub Profile
  • Creating and hosting web pages on GitHub
  • Auto-updating pages with GitHub Actions
Fancy GitHub
  • »
  • Let’s make you a fancy GitHub.
  • View page source

Let’s make you a fancy GitHub.

GitHub is a website to post all of your awful code, sure. It’s a website to complain about how other peoples’ awful code isn’t working, yes. But:

It’s also place where you can show off a little bit. So let’s do that! Let’s customize your GitHub until it shines like an uncomfortably bright sun.

Contents:

  • Welcome!
  • Organizing your repositories
    • What gets a repository?
    • What goes in my repository?
    • Repository name
    • Directory structure
    • File names
    • Competing code bases
    • No junk files!
  • Ignoring files with .gitignore
    • What is a .gitignore file?
    • What belongs in .gitignore?
    • Creating a .gitignore
    • Help! It’s already in the repo!
    • Files we shouldn’t ignore
  • README, your repo’s front page
    • What is a README?
    • Creating a README
    • README contents
    • Writing Markdown
  • Special considerations for Jupyter notebooks
    • Above all else: publish!
    • No errors
    • No long long outputs
    • Notebooks in the cloud
  • Customizing your GitHub Profile
    • Updating your bio
    • Selecting featured repositories
    • BONUS: A profile README
  • Creating and hosting web pages on GitHub
    • Building our website
    • Making our website look nice
    • Choosing your URL
    • The docs folder trick
  • Auto-updating pages with GitHub Actions
    • Prep work
    • How to do it

Indices and tables

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2021, Jonathan Soma.

Built with Sphinx using a theme provided by Read the Docs.