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

Add support for pluto #121

Merged
merged 13 commits into from
Oct 1, 2022
Merged

Conversation

Dsantra92
Copy link
Collaborator

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
Copy link
Member

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

@johnnychen94 johnnychen94 self-assigned this Aug 24, 2022
@johnnychen94
Copy link
Member

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

@johnnychen94
Copy link
Member

@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
Copy link
Collaborator Author

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

@Dsantra92
Copy link
Collaborator Author

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
Copy link
Member

You make the decision

@johnnychen94
Copy link
Member

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

@Dsantra92
Copy link
Collaborator Author

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

Project.toml Show resolved Hide resolved
src/types/pluto.jl Outdated Show resolved Hide resolved
src/types/pluto.jl Outdated Show resolved Hide resolved
src/types/pluto.jl Show resolved Hide resolved
src/types/pluto.jl Outdated Show resolved Hide resolved
src/types/pluto.jl Outdated Show resolved Hide resolved
src/utils.jl Outdated Show resolved Hide resolved
@CarloLucibello
Copy link

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
Copy link
Collaborator Author

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

@Dsantra92
Copy link
Collaborator Author

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.

Co-authored-by: Carlo Lucibello <carlo.lucibello@gmail.com>
@Dsantra92 Dsantra92 linked an issue Sep 30, 2022 that may be closed by this pull request
@CarloLucibello
Copy link

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

@Dsantra92 Dsantra92 merged commit b19b262 into JuliaDocs:master Oct 1, 2022
@Dsantra92
Copy link
Collaborator Author

There should be a minor version bump?

@CarloLucibello
Copy link

No breaking changes, so bump to 0.4.10

@Dsantra92 Dsantra92 mentioned this pull request Oct 2, 2022
@Dsantra92
Copy link
Collaborator Author

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

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

Successfully merging this pull request may close these issues.

Support Pluto.jl notebooks for demos?
3 participants