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

Idea for richer notebook format #421

Open
j-fu opened this issue Sep 13, 2020 · 4 comments
Open

Idea for richer notebook format #421

j-fu opened this issue Sep 13, 2020 · 4 comments
Labels
backend Concerning the julia server and runtime enhancement New feature or request

Comments

@j-fu
Copy link
Contributor

j-fu commented Sep 13, 2020

Hi, just a thought here for a possible modificatioon of the notebook format -- in case you are considering to extend the current format with more stored information:

I can imagine to use a special comment prefix and some standard way to store richer config information - Julia or (preferably) toml which you can parse to dicts using TOML.jl E.g. like this:

#═╡ [PlutoNotebook]
#═╡ format_version = "2.0"
#═╡ pluto_version  = "1.20"



#═╡ [PlutoCell]
#═╡ uuid = "7f904dfe-b85e-4ff6-b463-dae2292396a8"
#═╡ hidden = false
#═╡ show_output=true
#═╡ results_on_top=false
hack hack hack

#═╡ [CellOrder]
#═╡ order = [ 
#═╡	      "uuid1",
#═╡	      "uuid2"
#═╡	   ]

(not sure if the Julia toml parser supports arrays).

This would give you the possibility to add richer meta information to the notebook in an extendable way.

Edit: this could be consistent also with some of the ideas in e.g. #142 .:

#═╡ [PlutoProject] 
#═╡   project.toml stuff here
#═╡

Edit: I think an API for reading and writing notebooks could go into an extra package, thus allowing tools
like Literate to write notebooks through this API and encourage the development of a large tooling ecosystem.

@fonsp
Copy link
Owner

fonsp commented Sep 14, 2020

Thanks!

#311

(I'll point out that you can use ; as the last character of a cell to toggle showing output.)

@fonsp
Copy link
Owner

fonsp commented Sep 14, 2020

@fonsp fonsp closed this as completed Sep 14, 2020
@j-fu
Copy link
Contributor Author

j-fu commented Sep 14, 2020 via email

@lungben
Copy link
Contributor

lungben commented Mar 10, 2022

For cell metadata, this is implemented in #1895

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Concerning the julia server and runtime enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants