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

improvement: cleanup markdown, use prose #1892

Merged
merged 4 commits into from
Jul 26, 2024
Merged

improvement: cleanup markdown, use prose #1892

merged 4 commits into from
Jul 26, 2024

Conversation

mscolnick
Copy link
Contributor

@mscolnick mscolnick commented Jul 26, 2024

Cleanup markdown to allow for dynamic/responsive sizing across marging/padding/font-size/line-height by using tailwind typography.

Now we can easily add size to mo.md().

In future we can size the whole document (by app config or user config)

Copy link

vercel bot commented Jul 26, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
marimo-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 26, 2024 6:28pm
marimo-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 26, 2024 6:28pm

@mscolnick mscolnick changed the title improvement: cleanup markdown, use prose so can later add sizing improvement: cleanup markdown, use prose, add size to mo.md() Jul 26, 2024
@mscolnick mscolnick requested a review from akshayka July 26, 2024 12:12
Copy link
Contributor

@akshayka akshayka left a comment

Choose a reason for hiding this comment

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

On the whole, looks good! Some comments.

I like the responsiveness that this provides. But can we hold off adding size to the public API? I'd like to experiment more and see whether we can get away with only user config or app config.

A couple of things I noticed that would be good to fix before merging:

JSON Output size.

JSON Output embedded in markdown is now unnaturally big. It should have the same formatting as code, since it's monospace. I tried fixing this myself, but wasn't sure how to do it cleanly through tailwind.config.js alone and spent too much time trying to figure it out. Would appreciate help.

This is what I would like it to look like (how it is today, on main):

image

But in this PR, marimo-json-output is unnaturally big. If marimo-json-output could pick up the same styles that tailwind puts on .prose pre, that would be okay. Here is what it looks like in this PR:

image

Bullet legibility.

The bullet color is very light now, and hard to see. I'm all for minimalist, unobtrusive design, but this is too minimalist even for me. Can we darken it?

@akshayka akshayka changed the title improvement: cleanup markdown, use prose, add size to mo.md() improvement: cleanup markdown, use prose Jul 26, 2024
@akshayka akshayka merged commit 15fa75a into main Jul 26, 2024
31 checks passed
@akshayka akshayka deleted the ms/cleanup-markdown branch July 26, 2024 18:50
Copy link

🚀 Development release published. You may be able to view the changes at https://marimo.app?v=0.7.13-dev2

akshayka added a commit that referenced this pull request Aug 4, 2024
This reverts commit 15fa75a.

Tailwind prose broke dark mode colors. Reverting for now so that dark
mode users can enjoy the other new features and bug fixes in
0.7.14-0.7.16. We can bring it back when the styling bug is fixed.
akshayka added a commit that referenced this pull request Aug 4, 2024
* Revert "improvement: cleanup markdown, use prose (#1892)"

This reverts commit 15fa75a.

Tailwind prose broke dark mode colors. Reverting for now so that dark
mode users can enjoy the other new features and bug fixes in
0.7.14-0.7.16. We can bring it back when the styling bug is fixed.

* fix revert
mscolnick added a commit that referenced this pull request Aug 12, 2024
mscolnick added a commit that referenced this pull request Aug 12, 2024
* Revert "Revert "improvement: cleanup markdown, use prose (#1892)" (#1950)"

This reverts commit f1b0c84.

* fix dark mode

* dedupe
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants