Skip to content

chore: testing README with quick fixes on indentation and branch #1

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

Open
bobleesj wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: testing README with quick fixes on indentation and branch #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6bbc0fb
add -b to create dev branch off of main
sl5400 Sep 26, 2025
7d91050
indent jupyter comment section
sl5400 Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This quickstart guide was developed by [Colin Ophus](mailto:cophus@gmail.com) an

Steps to edit locally:
- git clone repo (`git clone git@github.com:msa-em/change-to-repo-name.git`)
- switch to `dev` branch (`git checkout dev`)
- switch to `dev` branch (`git checkout -b dev`)
Copy link
Copy Markdown
Author

@bobleesj bobleesj Sep 26, 2025

Choose a reason for hiding this comment

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

I tried git checkout dev but it appears we only have main once forked, so create a new local dev branch.

- edit `environment.yml` to
- change the environment `name` to the repo name
- add your package dependencies, pinning versions as necessary
Expand All @@ -32,7 +32,7 @@ Steps to edit locally:
```
- uncommenting these lines
```yml
# jupyter:
# jupyter:
# server:
# url: 'http://localhost:8888'
# token: '512ac78f14e1141db1fac17e8b4099c1e5bc7d589518b38c'
Expand Down
16 changes: 8 additions & 8 deletions myst.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ project:
- Spell Out Acronyms
github: https://github.com/msa-em/change-this-to-repo-name
jupyter: true
# jupyter:
# binder:
# url: https://y2j74k9mn0bz.curvenote.dev/services/binder/
# repo: msa-em/change-this-to-repo-name
# jupyter:
# server:
# url: 'http://localhost:8888'
# token: '512ac78f14e1141db1fac17e8b4099c1e5bc7d589518b38c'
# jupyter:
Copy link
Copy Markdown
Author

@bobleesj bobleesj Sep 26, 2025

Choose a reason for hiding this comment

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

Turns out when I uncomment, it gets the right indentation without the extra space.

# binder:
# url: https://y2j74k9mn0bz.curvenote.dev/services/binder/
# repo: msa-em/change-this-to-repo-name
# jupyter:
# server:
# url: 'http://localhost:8888'
# token: '512ac78f14e1141db1fac17e8b4099c1e5bc7d589518b38c'
open_access: true
license: CC-BY-4.0
banner: banner.png
Expand Down