-
Notifications
You must be signed in to change notification settings - Fork 43
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.
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
Markdown notebook #248
base: main
Are you sure you want to change the base?
Markdown notebook #248
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
This pull request is being automatically built with GitHub Actions and Netlify. To see the status of your deployment, click below. 🔍 Git commit SHA: 13d580f |
This looks great @dcamron! I think it is just the right coverage for our goals. A couple of suggestions:
|
@dcamron: To get the link-checker action to pass, you may need to update your branch with the most recent changes in the |
@@ -0,0 +1,288 @@ | |||
{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are a lot of options for formatting the text in your Jupyter markdown cells. This section will introduce some of the most useful Markdown syntax tips and tricks.
- Markdown Cells
- Headings
- Lists
- Other Text Formats
- Tables
- Images
- Equations
Reply via ReviewNB
@@ -0,0 +1,288 @@ | |||
{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@@ -0,0 +1,288 @@ | |||
{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Markdown Cells "/##"
Several of the sections seem to be at the wrong heading level
Reply via ReviewNB
@@ -0,0 +1,288 @@ | |||
{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it matter that math syntax highlighting works a little differently on a local Jupyter notebook vs on a Jupyterbook build (with different sphinx extensions being required and not all syntax options being available)? Without getting too complicated seems like it could be a small admonition/warning if hosting markdown on a website/blog.
Reply via ReviewNB
https://www.markdownguide.org/cheat-sheet/ Good cheat sheet^ And Myst documentation - https://mystmd.org/guide |
Draft, drop in Markdown in Jupyter content from Unidata's Python workshop materials. I might not be able to properly clean this up until next week, but wanted to put it in place in case anyone had specific requests for things to overview or external resources to link to.