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

🎨 Theme updates for showing proofs, algorithms, and github previews #140

Merged
merged 2 commits into from
May 16, 2023

Conversation

rowanc1
Copy link
Member

@rowanc1 rowanc1 commented May 15, 2023

This incorporates the work on the sphinx proof as well as many other small updates to the theme that have been added by @tavin and me over the past month or so!

There are a few things that I am noticing over here around spacing/margin updates, but overall things are working much better!!

@agoose77 I wonder if you could help with the testing/deploy of this for @mmcky, who is looking for some of these updates. I did a first pass test locally, but it probably needs a manual go through/test. If you are game to release that would be awesome (I am on vacation for the next 1.5 weeks!! ⛱).

This introduces:

  • proofs
  • github hover links for issues and PRs
  • better hover infrastructure for any internal references
  • simplified code-block styles
  • many subtle style improvements (e.g. around margins and typography)

jupyterlab-myst-proof

@github-actions
Copy link
Contributor

Binder 👈 Launch a Binder on branch executablebooks/jupyterlab-myst/feat/proof

@rowanc1 rowanc1 added the enhancement New feature or request label May 15, 2023
@rowanc1
Copy link
Member Author

rowanc1 commented May 16, 2023

please update playwright snapshots

@agoose77
Copy link
Collaborator

@rowanc1 I looked over this and it looks good to me. I think we're at a stage where making these kinds of releases should lean towards new features as a priority, so I am keen to merge this as is!

Small point: I noticed that we support code-cell directives in notebooks. I wonder whether we should prevent that, as it's my understanding that we normally expect these only at the top level, and JupyterLab-myst is highly unlikely to ever support cell-in-markdown (certainly I wouldn't prioritise it, as it's highly non-standard).

Also, do we parse the link previews as Markdown when they're taken from GitHub? I noticed that links in e.g. issue descriptions aren't rendered, and given that we know we're parsing GFM, perhaps we could do something here?

In any case, I'm going to merge this and make a release!

@agoose77 agoose77 merged commit 41f501e into main May 16, 2023
@agoose77 agoose77 deleted the feat/proof branch May 16, 2023 08:32
@rowanc1
Copy link
Member Author

rowanc1 commented May 16, 2023

Thank you!

Yes, we should parse the body, I considered leaving it out completely, but it is a bit better even there without the parsing for now.

Completely agree about removing or warning on the code-cell, it shouldn't do anything inside a notebook.

agoose77 pushed a commit that referenced this pull request May 30, 2023
…140)

* 🎨 Update for showing proofs

* Update Playwright Snapshots

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
agoose77 pushed a commit that referenced this pull request Jun 11, 2023
…140)

* 🎨 Update for showing proofs

* Update Playwright Snapshots

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
rowanc1 added a commit that referenced this pull request Jun 23, 2023
* Rework dependencies (#139)
* 🎨 Theme updates for showing proofs, algorithms, and github previews (#140)
* 🎨 Update for showing proofs
* Update Playwright Snapshots
* Pass trust to the mimerenderer (#150)
* Update `@jupyterlab/galata`?
* 🧪 Pass in request to `galata`
* Try `npm_client: jlpm`
* 🧹 Update yml formatting, to trigger build!
* Only reuse expressions if the model exists
* Remove block lifting
* Upgrade myst packages
* Turn ts-error into lint warning
* Fix local images in markdown files
* Add abbreviations and glossary transforms
* Fake get rid of the double render
* Backwards compatible with Jupyterlab3
* Consistent setters/getters on cell metadata
---------

Co-authored-by: Rowan Cockett <rowanc1@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants