JuliaDocs / DemoCards.jl

Let's focus on writing demos
MIT License
66 stars 14 forks source link

Add support for pluto #121

Closed Dsantra92 closed 2 years ago

Dsantra92 commented 2 years ago

Hi @johnnychen94, I did some work on the Pluto notebook. Sorry, it took so long. Currently, it supports rendering a pluto notebook using PlutoStaticHTML. I am concerned with adding a title and other badges to the rendered notebook.

However, parsing metadata won't be similar to Julia or markdown's. Pluto.jl has full control over a notebook's start and end content, so we might need to create special parse for Pluto that can parse metadata from the file allowing multiline regex matching. I need some advice as to whether I should go ahead with this approach.

johnnychen94 commented 2 years ago

@Dsantra92 Great! I'll check this PR this weekend and see if there's anything I can do to quickly get this in.

johnnychen94 commented 2 years ago

Sorry, it's a busy weekend, I'll manage to get some time for this PR ASAP

johnnychen94 commented 2 years ago

@Dsantra92 I failed to manage some time doing this (busy work, busy life); really sorry about this!

I didn't check it locally, but the overall changes look okay to me. I just sent you an write invitation to this package so if you're confident, you're free to merge this and add any wanted feature (and potential bug fixes 😆 ).

Dsantra92 commented 2 years ago

This pr isn't complete yet. I will merge when it's completed.

Dsantra92 commented 2 years ago

This is good to go as a beta feature. Example here. It will be complete with docs and some tests for edge cases ( I cannot add time for it this week). So should I merge this and open issues for docs and tests? @johnnychen94.

johnnychen94 commented 2 years ago

You make the decision

johnnychen94 commented 2 years ago

as long as there's a commitment, it's all okay to me

Dsantra92 commented 2 years ago

I think I can make the docs and basic tests work within the coming weeks. Let's merge this as a beta feature now.

CarloLucibello commented 2 years ago

Julia v1.0 is not supported by PlutoStaticHTML, we should update the julia version bound of DemoCards.jl to julia v1.6.

Not clear why windows test on latest julia are failing

Dsantra92 commented 2 years ago

Thanks for the review @CarloLucibello, will get the changes done asap.

Dsantra92 commented 2 years ago

Hi @CarloLucibello the changes you suggested to src/types/pluto.jl makes sense but I then the functions and doc style will differ from the exisiting markdown and julia files. Just wanted to make these things uniform across the different types.

CarloLucibello commented 2 years ago

ok, let's relax to AbstractString and merge and tag quickly then.

Dsantra92 commented 2 years ago

There should be a minor version bump?

CarloLucibello commented 2 years ago

No breaking changes, so bump to 0.4.10

Dsantra92 commented 2 years ago

I went to bump and release myself. Hope it's okay.