Skip to content
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

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

Conversation

dcamron
Copy link
Contributor

@dcamron dcamron commented Mar 9, 2022

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.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions
Copy link

github-actions bot commented Mar 9, 2022

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
✅ Deployment Preview URL: https://6255f6ca33e3660aae6f97fe--pythia-foundations.netlify.app

@clyne clyne added the content Content related issue label Mar 14, 2022
@clyne
Copy link
Contributor

clyne commented Mar 14, 2022

This looks great @dcamron! I think it is just the right coverage for our goals. A couple of suggestions:

  1. Would it make sense to explicitly suggest trying things out with Binder? Seems like a real simple way to reinforce the content...
  2. How about including how to add a Link?

@kmpaul kmpaul closed this Apr 12, 2022
@kmpaul kmpaul reopened this Apr 12, 2022
@kmpaul
Copy link
Contributor

kmpaul commented Apr 12, 2022

@dcamron: To get the link-checker action to pass, you may need to update your branch with the most recent changes in the main branch.

@@ -0,0 +1,288 @@
{
Copy link
Contributor

@jukent jukent Aug 15, 2024

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.

  1. Markdown Cells
  2. Headings
  3. Lists
  4. Other Text Formats
  5. Tables
  6. Images
  7. Equations

Reply via ReviewNB

@@ -0,0 +1,288 @@
{
Copy link
Contributor

@jukent jukent Aug 15, 2024

Choose a reason for hiding this comment

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

Markdown | Helpful|

5 minutes to learn?


Reply via ReviewNB

@@ -0,0 +1,288 @@
{
Copy link
Contributor

@jukent jukent Aug 15, 2024

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 @@
{
Copy link
Contributor

@jukent jukent Aug 15, 2024

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

@jukent
Copy link
Contributor

jukent commented Aug 15, 2024

https://www.markdownguide.org/cheat-sheet/

Good cheat sheet^

And Myst documentation - https://mystmd.org/guide

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Content related issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Markdown tutorial
4 participants