💌 Pluto.frontmatter

[fonsp]

frontmatter(nb::Notebook; raise::Bool=false)::Dict{String,Any}

Extract frontmatter from a notebook, which is extra meta-information that the author attaches to the notebook, often including title, description, tags, author, and more. Search for frontmatter online to learn more.

Currently, you can give frontmatter to a notebook by defining a global variable frontmatter anywhere in the notebook, which should be a named tuple.

frontmatter = (
	title = "⚡️ JavaScript for widgets",
	description = "A simple notebook demonstrating the Julia syntax essentials",
	layout = "layout.jlhtml",
	tags = ["docs", "advanced", "widgets"],
);

This definition will be picked up (using syntax analysis) and evaluated. Note:

• You are not allowed to use variables defined in other cells. (But you can use frontmatter in your notebook.)
• You can use ; to hide it from being displayed, only the definition matters.

This might change in the future, because we might make this a GUI thing!

Related to #1984

[github-actions]

Try this Pull Request!

Open Julia and type:

julia> import Pkg
julia> Pkg.activate(temp=true)
julia> Pkg.add(url="https://github.com/fonsp/Pluto.jl", rev="frontmatter-1")
julia> using Pluto

[rikhuijzer]

I like the idea of having a frontmatter which can contain any valid Julia object. Very clever. All systems that I know fallback to string representations.

[fonsp]

Yeah I think that that's nice for dates, not sure what else... Any cool ideas where this is useful?

[rikhuijzer]

Yeah I think that that's nice for dates, not sure what else... Any cool ideas where this is useful?

Images maybe? That it handles storing images and getting permalinks for the open graph for Twitter thumbnails and stuff